Struct tide_governor::GovernorMiddleware

pub struct GovernorMiddleware { /* fields omitted */ }

Once the rate limit has been reached, the middleware will respond with status code 429 (too many requests) and a Retry-After header with the amount of time that needs to pass before another request will be allowed.

Implementations

impl GovernorMiddleware

#[must_use]pub fn with_period(duration: Duration) -> Option<Self>

Constructs a rate-limiting middleware from a Duration that allows one request in the given time interval.

If the time interval is zero, returns None.

pub fn per_second<T>(times: T) -> Result<Self> where
    T: TryInto<NonZeroU32>,
    T::Error: Error + Send + Sync + 'static, 

Constructs a rate-limiting middleware that allows a specified number of requests every second.

Returns an error if times can't be converted into a NonZeroU32.

pub fn per_minute<T>(times: T) -> Result<Self> where
    T: TryInto<NonZeroU32>,
    T::Error: Error + Send + Sync + 'static, 

Constructs a rate-limiting middleware that allows a specified number of requests every minute.

Returns an error if times can't be converted into a NonZeroU32.

pub fn per_hour<T>(times: T) -> Result<Self> where
    T: TryInto<NonZeroU32>,
    T::Error: Error + Send + Sync + 'static, 

Constructs a rate-limiting middleware that allows a specified number of requests every hour.

Returns an error if times can't be converted into a NonZeroU32.

Trait Implementations

impl Clone for GovernorMiddleware

pub fn clone(&self) -> GovernorMiddleware

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GovernorMiddleware

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

Formats the value using the given formatter.

impl<State: Clone + Send + Sync + 'static> Middleware<State> for GovernorMiddleware

pub fn handle<'life0, 'life1, 'async_trait>(
    &'life0 self,
    req: Request<State>,
    next: Next<'life1, State>
) -> Pin<Box<dyn Future<Output = Result> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Asynchronously handle the request, and return a response.

pub fn name(&self) -> &str

Set the middleware's name. By default it uses the type signature.