Enum SubscriptionMode 

#[repr(u8)]
pub enum SubscriptionMode {
    Raw = 0,
    Merge = 1,
    Distinct = 2,
    Command = 3,
}

How the server treats the items of a subscription [docs/spec/03-requests.md §6.1].

The mode is not a preference — it changes what the data means, and an item may only be subscribed in the modes its Data Adapter supports.

Mode	The server keeps	A snapshot is	Typical use
Merge	the current value of every field	the current state	a quote: price, bid, ask
Distinct	recent events, unmerged	the most recent events	a news feed, a chat
Command	a keyed table	the rows of the table	an order book, a portfolio
Raw	nothing	not available	a firehose you filter yourself

In every mode but Raw the server may filter, buffer and limit the flow; Raw forwards each update as it is and is the one mode with no server-side bookkeeping at all.

Variants

Raw = 0

Every update is forwarded as-is. No item state is kept, no snapshot is available, and no filtering is applied.

Merge = 1

The server keeps the current value of each field and merges each update into it, so an update carries only what changed and a snapshot is the current state.

Distinct = 2

Each update is a distinct event that does not replace the previous one. A snapshot is the most recent events, up to a length the server or the subscription chooses.

Command = 3

Updates carry ADD, UPDATE and DELETE commands against a key field, forming a table. The field schema must contain a key field and a command field, or the server rejects the subscription with Appendix B code 15 or 16 [docs/spec/05-error-codes.md §2].

Implementations

impl SubscriptionMode

pub const fn as_str(self) -> &'static str

The mode as the protocol spells it: RAW, MERGE, DISTINCT or COMMAND.

Trait Implementations

impl Clone for SubscriptionMode

fn clone(&self) -> SubscriptionMode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SubscriptionMode

impl Debug for SubscriptionMode

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

Formats the value using the given formatter.

impl Eq for SubscriptionMode

impl Hash for SubscriptionMode

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 SubscriptionMode

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for SubscriptionMode

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