Enum UpdateFrequency 

#[non_exhaustive]
pub enum UpdateFrequency {
    Unlimited,
    Limited {
        updates_per_second: String,
    },
    Unrecognized {
        literal: String,
    },
}

The update rate the server has settled on for a subscription [docs/spec/04-notifications.md §3.8].

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Unlimited

No limit is applied.

Limited

At most this many updates per second, per item.

Fields

updates_per_second: String

The limit exactly as the server wrote it. Kept as text because the protocol carries it as text and this crate never reinterprets a server-supplied number on the caller’s behalf.

Unrecognized

The rate could not be read, so do not treat it as a limit.

The server sent something that is neither unlimited nor a decimal number [docs/spec/04-notifications.md §3.8]. It is reported rather than dropped, and reported apart from Limited rather than inside it, because a caller that reads Limited { updates_per_second: "" } and divides by it is acting on a number nobody sent. Log it, or treat the subscription’s rate as unknown — but do not compute with it.

Fields

literal: String

The value as it arrived.

Trait Implementations

impl Clone for UpdateFrequency

fn clone(&self) -> UpdateFrequency

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateFrequency

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

Formats the value using the given formatter.

impl Eq for UpdateFrequency

impl Hash for UpdateFrequency

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 Ord for UpdateFrequency

fn cmp(&self, other: &UpdateFrequency) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for UpdateFrequency

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for UpdateFrequency

fn partial_cmp(&self, other: &UpdateFrequency) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for UpdateFrequency