Struct Config

Source
pub struct Config<T: Time = SystemTime> { /* private fields */ }
Expand description

Config for rate limiting.

This object contains the configuration for the rate limits but does not actually hold any rate limiting state. It is often constructed once globally and used for many rate limits however it can also be constructed dynamically if desired.

Implementations§

Source§

impl<T: Time> Config<T>

Source

pub const fn new(rate: T::Duration, burst: u32) -> Self

Create a new config.

  • rate: The amount of time that must elapse between each unit of request on average. Must be greater than zero.
  • burst: The maximum units that can be used instantaneously.

In other words this is configuring a token bucket where rate is the fill rate and burst is the maximum capacity.

The tokens are always replenished one-at-a-time. For example “10 tokens even 1min” isn’t supported. Instead you would configure “1 token every 6 seconds” which is the same average rate but granted evenly throughout the minute.

Source

pub fn disabled() -> Self

Create a config that will never generate tokens.

Acquisitions will always fail unless the tracker is overfull.

Source

pub fn is_disabled(&self) -> bool

Returns true if this config will not generate tokens on its own.

Note that a disabled config can still grant tokens if the tracker is overfull.

Source

pub fn token_rate(&self) -> T::Duration

The rate at which new tokens appear in the bucket.

This duration represents the period between token additions to the capacity tokens always become available one at a time.

Source

pub fn burst_capacity(&self) -> u32

The maximum fill capacity.

This is the maximum capacity that trackers will fill to if left idle.

Note that the capacity may exceed this value if artificially raised such as via [Tracker::overfull()], [Tracker::with_capacity_at()] or [Tracker::add_capacity_at()].

Trait Implementations§

Source§

impl<T: Clone + Time> Clone for Config<T>
where T::Duration: Clone,

Source§

fn clone(&self) -> Config<T>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Debug + Time> Debug for Config<T>
where T::Duration: Debug,

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T> Freeze for Config<T>
where <T as Time>::Duration: Freeze,

§

impl<T> RefUnwindSafe for Config<T>
where <T as Time>::Duration: RefUnwindSafe,

§

impl<T> Send for Config<T>
where <T as Time>::Duration: Send,

§

impl<T> Sync for Config<T>
where <T as Time>::Duration: Sync,

§

impl<T> Unpin for Config<T>
where <T as Time>::Duration: Unpin,

§

impl<T> UnwindSafe for Config<T>
where <T as Time>::Duration: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.