Struct ThrottleSpec

pub struct ThrottleSpec {
    pub limit: u64,
    pub period: u64,
    pub max_burst: Option<u64>,
    pub force_local: bool,
}

Fields

limit: u64

period: u64

Period, in seconds

max_burst: Option<u64>

Constrain how quickly the throttle can be consumed per throttle interval (period / limit). max_burst defaults to limit, allowing the entire throttle to be used in an instant. Setting max_burst to 1 will only allow 1 throttle bump per interval, spreading out the utilization of the throttle more evenly over time. Larger values allow more of the throttle to be used per period.

force_local: bool

Implementations

impl ThrottleSpec

pub async fn throttle<S: AsRef<str>>( &self, key: S, ) -> Result<ThrottleResult, Error>

pub async fn throttle_quantity<S: AsRef<str>>( &self, key: S, quantity: u64, ) -> Result<ThrottleResult, Error>

impl ThrottleSpec

pub fn as_string(&self) -> String

Trait Implementations

impl Clone for ThrottleSpec

fn clone(&self) -> ThrottleSpec

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ThrottleSpec

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ThrottleSpec

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ThrottleSpec

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<ThrottleSpec> for String

fn from(spec: ThrottleSpec) -> String

Converts to this type from the input type.

impl Hash for ThrottleSpec

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ThrottleSpec

fn eq(&self, other: &ThrottleSpec) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ThrottleSpec

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for ThrottleSpec

type Error = String

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Self, String>

Performs the conversion.

impl TryFrom<String> for ThrottleSpec

type Error = String

The type returned in the event of a conversion error.

fn try_from(s: String) -> Result<Self, String>

Performs the conversion.

impl Copy for ThrottleSpec

impl Eq for ThrottleSpec

impl StructuralPartialEq for ThrottleSpec