Skip to main content

LimitState

axum_limit

Struct LimitState 

Source 
pub struct LimitState<K, P = TokenBucketPolicy, B = MemoryBackend> { /* private fields */ }
Expand description

Manages per-key state for a specific RateLimitPolicy and RateLimitBackend.

Implementations§

Source§

impl<K, P, B> LimitState<K, P, B>
where K: Key, P: RateLimitPolicy, B: RateLimitBackend,

Source

pub fn new(backend: B) -> Self

Creates a limit state backed by the provided storage backend.

Source

pub fn backend(&self) -> &B

Returns the configured storage backend.

Source

pub async fn check( &self, key: K, quota: Quota, ) -> Result<RateLimitSnapshot, B::Error>
where K: StorageKey,

Checks and updates the rate limit for the given key.

Trait Implementations§

Source§

impl<K: Clone, P: Clone, B: Clone> Clone for LimitState<K, P, B>

Source§

fn clone(&self) -> LimitState<K, P, B>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<K, P> Default for LimitState<K, P, MemoryBackend>
where K: Key, P: RateLimitPolicy,

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<K, P, B> Freeze for LimitState<K, P, B>
where B: Freeze,

§

impl<K, P, B> RefUnwindSafe for LimitState<K, P, B>
where B: RefUnwindSafe, K: RefUnwindSafe, P: RefUnwindSafe,

§

impl<K, P, B> Send for LimitState<K, P, B>
where B: Send, K: Send, P: Send,

§

impl<K, P, B> Sync for LimitState<K, P, B>
where B: Sync, K: Sync, P: Sync,

§

impl<K, P, B> Unpin for LimitState<K, P, B>
where B: Unpin, K: Unpin, P: Unpin,

§

impl<K, P, B> UnsafeUnpin for LimitState<K, P, B>
where B: UnsafeUnpin,

§

impl<K, P, B> UnwindSafe for LimitState<K, P, B>
where B: UnwindSafe, K: UnwindSafe, P: 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> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more