Struct BucketState 

pub struct BucketState {
    tokens: u128,
    last: Instant,
}

The mutable half of a token bucket: what it holds and when it was last refilled.

Session-scoped and shared by every stream of a class, so it is the scheduler’s state and not a stream’s. Kept separate from BucketConfig so the configuration stays comparable and cloneable while the state stays exactly one owner’s.

Fields

tokens: u128

Held tokens in nano-bytes. Never exceeds burst_bytes * NANO and never goes negative — the type forbids it, and so does the rate bound the bucket exists to hold.

last: Instant

The instant tokens was last brought up to date.

Implementations

impl BucketState

pub fn new(burst_bytes: u64, now: Instant) -> Self

A bucket that starts full at burst_bytes, as of now.

Starting full is what makes the first unit of a session go immediately; starting empty would put a burst_bytes / rate_bps delay in front of every stream and read as a broken proxy.

pub fn available_bytes(&self) -> u64

Whole bytes currently held, as of the last charge.

Does not refill: this is a read of recorded state, not a clock reading, so it stays usable from a test that fabricates its own instants.

Trait Implementations

impl Clone for BucketState

fn clone(&self) -> BucketState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for BucketState

impl Debug for BucketState

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

Formats the value using the given formatter.

impl Eq for BucketState

impl PartialEq for BucketState

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for BucketState