Struct Rate 

pub struct Rate {
    pub num: u32,
    pub period: Duration,
}

A rate: num events per period. Build by hand or parse the "<num>/<period>" string with Rate::parse.

Fields

num: u32

Maximum number of events allowed within one period.

period: Duration

The sliding window length.

Implementations

impl Rate

pub fn new(num: u32, period: Duration) -> Self

Construct directly from a count and a window.

pub fn parse(s: &str) -> Result<Self, String>

Parse a rate string: "<num>/<period>".

num is a positive integer; period is one of (case-insensitive):

period token	window
sec, s, second	1 second
min, m, minute	60 seconds
hour, h	3600 seconds
day, d	86400 seconds

A bare number with no separator is also accepted as a per-second rate (the "<num>" shorthand), e.g. "5" ≡ "5/sec". Anything else — empty string, non-numeric count, zero count, unknown period — returns Err with a short message.

assert_eq!(Rate::parse("100/hour").unwrap().num, 100);
assert_eq!(Rate::parse("10/min").unwrap().period, Duration::from_secs(60));
assert!(Rate::parse("oops").is_err());

Trait Implementations

impl Clone for Rate

fn clone(&self) -> Rate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Rate

impl Debug for Rate

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

Formats the value using the given formatter.

impl Eq for Rate

impl PartialEq for Rate

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Rate