Struct WriteMeter 

pub struct WriteMeter<C: Clock = DefaultClock> {
    limits: WriteLimits,
    ops: RateLimiter<String, HashMapStateStore<String>, C, NoOpMiddleware<<C as Clock>::Instant>>,
    bytes: RateLimiter<String, HashMapStateStore<String>, C, NoOpMiddleware<<C as Clock>::Instant>>,
    clock: C,
    last_swept: Mutex<Instant>,
}

The two buckets for every account that has written lately. A bucket that has refilled is dropped, since a missing one starts full anyway.

Fields

limits: WriteLimits

ops: RateLimiter<String, HashMapStateStore<String>, C, NoOpMiddleware<<C as Clock>::Instant>>

bytes: RateLimiter<String, HashMapStateStore<String>, C, NoOpMiddleware<<C as Clock>::Instant>>

clock: C

last_swept: Mutex<Instant>

Implementations

impl WriteMeter

pub fn new(limits: WriteLimits) -> Self

A meter on the system’s monotonic clock.

impl<C: Clock + Clone> WriteMeter<C>

pub fn with_clock(limits: WriteLimits, clock: C) -> Self

A meter on clock, which a test can advance by hand.

Panics

If a rate or burst in limits is zero, a burst is past u32::MAX, or a rate refills a token in under a nanosecond. Overflows if a slow rate meets a large burst. WriteLimits::check refuses each of these.

pub fn limits(&self) -> WriteLimits

The limits this meter enforces.

pub fn charge(&self, did: &str, ops: u32, bytes: u64) -> Result<(), Refusal>

Spends ops operations and bytes bytes of did’s buckets, or refuses and spends nothing more.

Operations are spent first. A write the byte bucket refuses keeps them spent.

fn sweep(&self)

Drops refilled buckets, at most once per SWEEP_EVERY, so the maps hold the accounts writing now rather than every account that has.

fn spend( &self, limiter: &RateLimiter<String, HashMapStateStore<String>, C, NoOpMiddleware<<C as Clock>::Instant>>, key: &String, bucket: Bucket, wanted: u64, ) -> Result<(), Refusal>

Trait Implementations

impl Default for WriteMeter

fn default() -> Self

Returns the “default value” for a type.