Enum MaxFrequency 

pub enum MaxFrequency {
    Unlimited,
    Unfiltered,
    Limited(FrequencyLimit),
}

A ceiling on how often the server may send updates for an item [docs/spec/03-requests.md §6.1].

Frequency limiting happens on the server, before the data is sent, so it is the effective way to protect a slow consumer: this crate never drops an update it has received (see Updates).

Variants

Unlimited

No limit: each update is sent as soon as possible. The server’s default.

Unfiltered

No limit and no losses: the server never merges or discards an update to keep up. If it cannot, it says so with an overflow notification rather than dropping silently [docs/spec/04-notifications.md §3]. Not compatible with a buffer size request, which the server ignores in this case.

Limited(FrequencyLimit)

At most this many updates per second, per item.

Implementations

impl MaxFrequency

pub fn limited( updates_per_second: impl Into<String>, ) -> Result<Self, ConfigError>

A ceiling in updates per second, written as a decimal number.

Errors

ConfigError::InvalidFrequency if the text is not a plain decimal number with a dot separator — 2, 0.5 and 12.75 are accepted; a sign, an exponent, a comma separator and a bare .5 are not.

Examples

use lightstreamer_rs::{ConfigError, MaxFrequency};

let twice_a_second = MaxFrequency::limited("2.0")?;
assert!(matches!(MaxFrequency::limited("2,0"), Err(ConfigError::InvalidFrequency { .. })));

Trait Implementations

impl Clone for MaxFrequency

fn clone(&self) -> MaxFrequency

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MaxFrequency

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

Formats the value using the given formatter.

impl Default for MaxFrequency

fn default() -> MaxFrequency

Returns the “default value” for a type.

impl Eq for MaxFrequency

impl Hash for MaxFrequency

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 MaxFrequency

fn cmp(&self, other: &MaxFrequency) -> 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 MaxFrequency

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for MaxFrequency

fn partial_cmp(&self, other: &MaxFrequency) -> 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 MaxFrequency