Struct Bucket 

pub struct Bucket { /* private fields */ }

Available on crate feature server only.

A token bucket used for rate-limiting.

The bucket holds up to max tokens, refilled at a fixed rate of bytes_per_second over refill_period intervals. Bucket::consume drains tokens and reports when the next attempt is allowed.

Exposed so that embedders mounting the relay protocol on a custom HTTP server (where the stream is already framed and the internal RateLimited wrapper cannot be used) can apply the same rate-limit semantics at the frame layer.

Implementations

impl Bucket

pub fn new( max: i64, bytes_per_second: i64, refill_period: Duration, ) -> Result<Self, InvalidBucketConfig>

Creates a new bucket starting full at max tokens, refilled at bytes_per_second over refill_period intervals.

Errors

Returns InvalidBucketConfig when max, bytes_per_second, or refill_period are non-positive, or when the configuration would refill less than one token per period.

pub fn consume(&mut self, bytes: usize) -> Result<(), Instant>

Attempts to consume bytes tokens from the bucket.

Returns Ok(()) if enough tokens were available.

Errors

Returns Err(deadline) with the [time::Instant] at which enough tokens will have refilled to allow the request.

Trait Implementations

impl Debug for Bucket

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

Formats the value using the given formatter.