Struct governor::Quota

pub struct Quota { /* fields omitted */ }

A rate-limiting quota.

Quotas are expressed in a positive number of "cells" (the number of positive decisions / allowed items) per unit of time.

Neither the number of cells nor the unit of time may be zero.

Burst sizes

There are multiple ways of expressing the same quota: a quota given as Quota::per_second(1) allows, on average, the same number of cells through as a quota given as Quota::per_minute(60). However, the quota of Quota::per_minute(60) has a burst size of 60 cells, meaning it is possible to accommodate 60 cells in one go, followed by a minute of waiting.

Methods

impl Quota

pub const fn per_second(max_burst: NonZeroU32) -> Quota

Construct a quota for a number of cells per second.

pub const fn per_minute(max_burst: NonZeroU32) -> Quota

Construct a quota for a number of cells per 60-second period.

pub const fn per_hour(max_burst: NonZeroU32) -> Quota

Construct a quota for a number of cells per 60-minute (3600-second) period.

pub fn new(max_burst: NonZeroU32, per: Duration) -> Option<Quota>

Construct a quota for a given burst size per unit of time.

Returns None if the duration is zero.

Trait Implementations

impl Clone for Quota

fn clone(&self) -> Quota

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Quota

impl Eq for Quota

impl PartialEq<Quota> for Quota

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Debug for Quota

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

Formats the value using the given formatter.

impl StructuralPartialEq for Quota

impl StructuralEq for Quota