Struct BucketCfg 

pub struct BucketCfg {
    pub rate: u32,
    pub per: Duration,
    pub burst: u32,
}

Token-bucket configuration for one limit bucket.

A bucket starts full with burst tokens. It gains rate tokens every per, continuously (not in steps), and never holds more than burst. One call spends one token. So a quiet client may send burst calls at once, and a busy one is held to rate calls per per.

In a limits file the three keys are written as rate = 10, per = "1s", burst = 3. The per value is an integer followed by ms, s, m, h or d (see BrokerLimits::from_toml_str).

Examples

use std::time::Duration;
use brokapi_runtime::BucketCfg;

let cfg = BucketCfg { rate: 10, per: Duration::from_secs(1), burst: 3 };
assert_eq!(cfg.burst, 3);

Fields

rate: u32

Tokens added per per. Must be greater than zero for the bucket to ever refill.

per: Duration

The period in which rate tokens are added.

burst: u32

Bucket capacity, and the number of tokens it holds at start.

Trait Implementations

impl Clone for BucketCfg

fn clone(&self) -> BucketCfg

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BucketCfg

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BucketCfg

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for BucketCfg

fn eq(&self, other: &BucketCfg) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for BucketCfg