Struct SequenceName 

pub struct SequenceName(/* private fields */);

The name of an ordered message sequence [docs/spec/03-requests.md §12.1].

Messages sharing a sequence are delivered to the Metadata Adapter in order of their progressive number, and a message in no sequence is processed as soon as it arrives, possibly alongside others. A sequence is therefore how an application says “these messages must not overtake each other”.

Examples

use lightstreamer_rs::SequenceName as Sequence;

let orders = Sequence::try_new("ORDERS")?;
assert_eq!(orders.as_str(), "ORDERS");

Implementations

impl SequenceName

pub fn try_new(name: impl Into<String>) -> Result<Self, ConfigError>

Checks and wraps a sequence name.

Errors

ConfigError::InvalidSequenceName if the name is empty, contains anything but ASCII letters, digits and underscores, or is UNORDERED_MESSAGES — which earlier versions of the protocol used and which this one reserves, so the server would refuse it [docs/spec/03-requests.md §12.1].

Examples

use lightstreamer_rs::{ConfigError, SequenceName as Sequence};

assert!(matches!(
    Sequence::try_new("UNORDERED_MESSAGES"),
    Err(ConfigError::InvalidSequenceName { .. })
));

pub fn as_str(&self) -> &str

The name as it goes on the wire.

Trait Implementations

impl Clone for SequenceName

fn clone(&self) -> SequenceName

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SequenceName

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

Formats the value using the given formatter.

impl Eq for SequenceName

impl Hash for SequenceName

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 SequenceName

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for SequenceName

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