Enum RateClass 

pub enum RateClass {
    Rare,
    Low,
    Burst(u64),
    Other(String),
}

The declared rate class of an events subject (RFC 04 §1.3, RFC 08 §5).

Not a Declared column, and the difference is the point: the vocabulary is rare | low | burst(n/h), and the third is parameterized. Wrapping it in Declared would file every legitimate burst(240/h) under Other — the arm that means “a token this build does not know” — and lose the budget in the process. So this carries its own Other, the shape WireEncoding has had since v1.5.

Variants

Rare

rare — at most one an hour; silence is the normal state.

Low

low — at most sixty an hour.

Burst(u64)

burst(n/h) — an explicit per-hour budget.

Other(String)

A spelling this build does not know, carried verbatim.

Implementations

impl RateClass

pub fn parse(token: &str) -> RateClass

Read a rate token. Unknown spellings are carried, not rejected — this reads foreign slices (RFC 08 §6).

pub fn cap_per_hour(&self) -> Option<u64>

The declared ceiling in events per hour, where one is declared.

None for a spelling this build cannot read — which is not the same as “no ceiling”, and callers must not treat it as unlimited.

pub fn token(&self) -> String

The token as a registry TOML spells it.

Trait Implementations

impl Clone for RateClass

fn clone(&self) -> RateClass

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RateClass

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

Formats the value using the given formatter.

impl Display for RateClass

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

Formats the value using the given formatter.

impl Eq for RateClass

impl Hash for RateClass

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for RateClass

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for RateClass