Struct actix_limitation::Builder

pub struct Builder { /* private fields */ }

Rate limiter builder.

Implementations

impl Builder

pub fn limit(&mut self, limit: usize) -> &mut Self

Set upper limit.

pub fn period(&mut self, period: Duration) -> &mut Self

Set limit window/period.

pub fn key_by<F>(&mut self, resolver: F) -> &mut Selfwhere
    F: Fn(&ServiceRequest) -> Option<String> + Send + Sync + 'static,

Sets rate limit key derivation function.

Should not be used in combination with cookie_name or session_key as they conflict.

pub fn cookie_name(
    &mut self,
    cookie_name: impl Into<Cow<'static, str>>
) -> &mut Self

👎Deprecated: Prefer key_by.

Sets name of cookie to be sent.

This method should not be used in combination of key_by as they conflict.

pub fn session_key(
    &mut self,
    session_key: impl Into<Cow<'static, str>>
) -> &mut Self

👎Deprecated: Prefer key_by.

Sets session key to be used in backend.

This method should not be used in combination of key_by as they conflict.

pub fn build(&mut self) -> Result<Limiter, Error>

Finalizes and returns a Limiter.

Note that this method will connect to the Redis server to test its connection which is a synchronous operation.

Trait Implementations

impl Debug for Builder

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

Formats the value using the given formatter.