[−][src]Struct ratelimit_meter::state::direct::Builder

pub struct Builder<P, A> where
    P: Relative,
    A: Algorithm<P> + Sized,  { /* fields omitted */ }

An object that allows incrementally constructing rate Limiter objects.

Methods

`impl<P, A> Builder<P, A> where P: Relative, A: Algorithm + Sized,` [src]

`pub fn cell_weight( &mut self, weight: NonZeroU32 ) -> Result<&mut Builder<P, A>, InconsistentCapacity>`[src]

Sets the "weight" of each cell being checked against the bucket. Each cell fills the bucket by this much.

`pub fn per(&mut self, time_unit: Duration) -> &mut Builder<P, A>`[src]

Sets the "unit of time" within which the bucket drains.

The assumption is that in a period of time_unit (if no cells are being checked), the bucket is fully drained.

`pub fn build(&self) -> Result<DirectRateLimiter<A, P>, InconsistentCapacity>`[src]

Builds a rate limiter of the specified type.

Auto Trait Implementations

`impl<P, A> Send for Builder<P, A>`

`impl<P, A> Sync for Builder<P, A>`

Blanket Implementations

`impl<T, U> Into for T where U: From<T>,` [src]

`fn into(self) -> U`[src]

`impl<T> From for T`[src]

`fn from(t: T) -> T`[src]

`impl<T, U> TryFrom for T where U: Into<T>,` [src]

`type Error = Infallible`

The type returned in the event of a conversion error.

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

`impl<T> Borrow for T where T: ?Sized,` [src]

ⓘImportant traits for &'_ mut R
Important traits for &'_ mut R
`impl<'_, R> Read for &'_ mut R where R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where W: Write + ?Sized, impl<'_, I> Iterator for &'_ mut I where I: Iterator + ?Sized, type Item = ::Item;impl<'_, F> Future for &'_ mut F where F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;`
`fn borrow(&self) -> &T`[src]

`impl<T> BorrowMut for T where T: ?Sized,` [src]

ⓘImportant traits for &'_ mut R
Important traits for &'_ mut R
`impl<'_, R> Read for &'_ mut R where R: Read + ?Sized, impl<'_, W> Write for &'_ mut W where W: Write + ?Sized, impl<'_, I> Iterator for &'_ mut I where I: Iterator + ?Sized, type Item = ::Item;impl<'_, F> Future for &'_ mut F where F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;`
`fn borrow_mut(&mut self) -> &mut T`[src]

`impl<T, U> TryInto for T where U: TryFrom<T>,` [src]

`type Error = >::Error`

The type returned in the event of a conversion error.

[−][src]Struct ratelimit_meter::state::direct::Builder

Methods

`impl<P, A> Builder<P, A> where P: Relative, A: Algorithm<P> + Sized,` [src]

`pub fn cell_weight( &mut self, weight: NonZeroU32 ) -> Result<&mut Builder<P, A>, InconsistentCapacity>`[src]

`pub fn per(&mut self, time_unit: Duration) -> &mut Builder<P, A>`[src]

`pub fn build(&self) -> Result<DirectRateLimiter<A, P>, InconsistentCapacity>`[src]

Auto Trait Implementations

`impl<P, A> Send for Builder<P, A>`

`impl<P, A> Sync for Builder<P, A>`

Blanket Implementations

`impl<T, U> Into for T where U: From<T>,` [src]

`fn into(self) -> U`[src]

`impl<T> From for T`[src]

`fn from(t: T) -> T`[src]

`impl<T, U> TryFrom for T where U: Into<T>,` [src]

`type Error = Infallible`

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

`impl<T> Borrow for T where T: ?Sized,` [src]

Important traits for &'_ mut R

`impl<T> BorrowMut for T where T: ?Sized,` [src]

Important traits for &'_ mut R

`impl<T, U> TryInto for T where U: TryFrom<T>,` [src]

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

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

`impl<T> Any for T where T: 'static + ?Sized,` [src]

`fn type_id(&self) -> TypeId`[src]

`impl<T> Erased for T`

[−][src]Struct ratelimit_meter::state::direct::Builder

Methods

impl<P, A> Builder<P, A> where P: Relative, A: Algorithm<P> + Sized, [src]

pub fn cell_weight( &mut self, weight: NonZeroU32) -> Result<&mut Builder<P, A>, InconsistentCapacity>[src]

pub fn per(&mut self, time_unit: Duration) -> &mut Builder<P, A>[src]

pub fn build(&self) -> Result<DirectRateLimiter<A, P>, InconsistentCapacity>[src]

Auto Trait Implementations

impl<P, A> Send for Builder<P, A>

impl<P, A> Sync for Builder<P, A>

Blanket Implementations

impl<T, U> Into for T where U: From<T>, [src]

fn into(self) -> U[src]

impl<T> From for T[src]

fn from(t: T) -> T[src]

impl<T, U> TryFrom for T where U: Into<T>, [src]

type Error = Infallible

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

impl<T> Borrow for T where T: ?Sized, [src]

Important traits for &'_ mut R

impl<T> BorrowMut for T where T: ?Sized, [src]

Important traits for &'_ mut R

impl<T, U> TryInto for T where U: TryFrom<T>, [src]

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

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

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

fn type_id(&self) -> TypeId[src]

impl<T> Erased for T

`impl<P, A> Builder<P, A> where P: Relative, A: Algorithm<P> + Sized,` [src]

`pub fn cell_weight( &mut self, weight: NonZeroU32 ) -> Result<&mut Builder<P, A>, InconsistentCapacity>`[src]

`pub fn per(&mut self, time_unit: Duration) -> &mut Builder<P, A>`[src]

`pub fn build(&self) -> Result<DirectRateLimiter<A, P>, InconsistentCapacity>`[src]

`impl<P, A> Send for Builder<P, A>`

`impl<P, A> Sync for Builder<P, A>`

`impl<T, U> Into for T where U: From<T>,` [src]

`fn into(self) -> U`[src]

`impl<T> From for T`[src]

`fn from(t: T) -> T`[src]

`impl<T, U> TryFrom for T where U: Into<T>,` [src]

`type Error = Infallible`

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

`impl<T> Borrow for T where T: ?Sized,` [src]

`impl<T> BorrowMut for T where T: ?Sized,` [src]

`impl<T, U> TryInto for T where U: TryFrom<T>,` [src]

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

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

`impl<T> Any for T where T: 'static + ?Sized,` [src]

`fn type_id(&self) -> TypeId`[src]

`impl<T> Erased for T`