# Builder in actix_limitation - Rust
Rate limit builder.
Keywords: rust, rustlang, rust-lang, Builder

# Struct actix_limitation::Builder

source · [−]

    pub struct Builder<'a> { /* private fields */ }

Expand description

Rate limit builder.

## Implementations

source

### impl Builder<'_>

source

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

Set upper limit.

source

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

Set limit window/period.

source

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

Set name of cookie to be sent.

source

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

Set session key to be used in backend.

source

#### pub fn build(&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

source

### impl<'a> Debug for Builder<'a>

source

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

Formats the value using the given formatter. Read more

## Auto Trait Implementations

### impl<'a> RefUnwindSafe for Builder<'a>

### impl<'a> Send for Builder<'a>

### impl<'a> Sync for Builder<'a>

### impl<'a> Unpin for Builder<'a>

### impl<'a> UnwindSafe for Builder<'a>

## 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,

const: unstable · source

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

### impl<T> From<T> for T

const: unstable · source

#### fn from(t: T) -> T

Returns the argument unchanged.

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>,

const: unstable · 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> Same<T> for T

#### type Output = T

Should always be `Self`

source

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

#### type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · 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>,

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

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

### impl<V, T> VZip<V> for T where
V: MultiLane<T>,

#### fn vzip(self) -> V

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