Struct Policy 

#[non_exhaustive]
pub struct Policy {
    pub burst: usize,
    pub tokens: usize,
    pub period: Duration,
    pub apply: usize,
    pub name: Option<&'static str>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

burst: usize

tokens: usize

period: Duration

apply: usize

name: Option<&'static str>

Implementations

impl Policy

pub const fn new( burst: usize, tokens: usize, period: Duration, apply: usize, ) -> Policy

pub const fn from_tokens_per_second(tokens: usize) -> Policy

pub const fn from_tokens_per_minute(tokens: usize) -> Policy

pub const fn from_tokens_per_hour(tokens: usize) -> Policy

pub const fn from_tokens_per_day(tokens: usize) -> Policy

pub const fn from_tokens_per_period(tokens: usize, period: Duration) -> Policy

pub const fn max_burst(self, burst: usize) -> Policy

pub const fn apply_tokens(self, apply: usize) -> Policy

pub const fn name(self, name: &'static str) -> Policy

Trait Implementations

impl Clone for Policy

fn clone(&self) -> Policy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Policy

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

Formats the value using the given formatter.

impl Copy for Policy