Struct TokenBucket 

pub struct TokenBucket { /* private fields */ }

A token bucket: it earns a number of tokens an hour up to its size, and a relay spends one on each message it lets through.

Implementations

impl TokenBucket

pub const fn new(reload_rate: u8, size: u16) -> TokenBucket

A bucket that earns reload_rate tokens an hour and holds size, starting full.

Arguments

• reload_rate - tokens earned an hour.
• size - the most tokens it holds.

Returns

The bucket.

pub const fn coded( reload_rate: u8, bucket_size: u8, unlimited: u8, ) -> TokenBucket

A bucket as a relay command codes it, starting full.

Arguments

• reload_rate - tokens earned an hour, or unlimited for no limit.
• bucket_size - the coded size multiplier, TS011-1.0.1 table 55; only its low two bits are read.
• unlimited - the rate that means no limit: UNLIMITED_DEVICE_RATE or UNLIMITED_RELAY_RATE.

Returns

The bucket.

pub const fn unlimited() -> TokenBucket

A bucket that never runs out.

Returns

The bucket.

pub const fn reload_rate(&self) -> Option<u8>

Returns how many tokens the bucket earns an hour.

Returns

The rate, or None for no limit.

pub const fn size(&self) -> u16

Returns the most tokens the bucket holds.

Returns

The size, 0 for a bucket with no limit.

pub const fn tokens(&self) -> u16

Returns the tokens the bucket holds now.

Returns

The count, 0 for a bucket with no limit.

pub const fn has_token(&self) -> bool

Reports whether a message may pass.

Returns

true for a bucket with no limit or a token left.

pub const fn disabled(&self) -> bool

Reports whether the bucket is empty and never refills, which a relay reports as forwarding disabled.

Returns

true for an empty bucket that earns nothing.

pub fn take(&mut self) -> bool

Spends a token.

Returns

false, spending nothing, when the bucket is empty.

pub fn reload(&mut self, hours: u64)

Adds what the bucket earns over some hours, keeping no more than its size.

Arguments

• hours - the whole hours since the last reload.

pub fn set_tokens(&mut self, tokens: u16)

Sets the tokens, keeping no more than the bucket’s size.

Arguments

• tokens - the count.

pub fn refill_one_hour(&mut self)

Sets the tokens to one hour’s reload, as a relay does when it starts scanning.

Trait Implementations

impl Clone for TokenBucket

fn clone(&self) -> TokenBucket

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for TokenBucket

impl Debug for TokenBucket

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

Formats the value using the given formatter.

impl Eq for TokenBucket

impl Hash for TokenBucket

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for TokenBucket

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for TokenBucket