Enum Snapshot 

#[repr(u8)]
pub enum Snapshot {
    Off,
    On,
    Length(NonZeroU32),
}

Whether the server should send the current state before the live flow [docs/spec/03-requests.md §6.1].

A snapshot lets an application start from a complete picture instead of waiting for every field to tick. Its meaning depends on the mode: in SubscriptionMode::Merge it is the current value of every field, in SubscriptionMode::Distinct the most recent events, in SubscriptionMode::Command the rows of the table. It is not available in SubscriptionMode::Raw at all.

Variants

Off

Do not send a snapshot; start from the live flow. The server’s default.

On

Send the snapshot, which may legitimately be empty.

Length(NonZeroU32)

Send at most this many snapshot events.

Accepted only with SubscriptionMode::Distinct; the server rejects it for the other modes. Fewer events may arrive, if the server has fewer or imposes a stricter limit.

Implementations

impl Snapshot

pub const fn is_requested(self) -> bool

Whether this asks the server for a snapshot at all.

Trait Implementations

impl Clone for Snapshot

fn clone(&self) -> Snapshot

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Snapshot

impl Debug for Snapshot

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

Formats the value using the given formatter.

impl Default for Snapshot

fn default() -> Snapshot

Returns the “default value” for a type.

impl Eq for Snapshot

impl Hash for Snapshot

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 Snapshot

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Snapshot

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