Enum StreamMode 

pub enum StreamMode {
    On,
    Off,
    All,
    OnAll,
    Recent(u32),
}

Mode selector for commands that share the on/off/all/on-all/N grammar. This is used by log, state, and echo, all of which support identical sub-commands.

Variants

On

Enable real-time notifications.

Off

Disable real-time notifications.

All

Dump the entire history buffer.

OnAll

Atomically enable real-time notifications AND dump history. This guarantees no messages are missed between the dump and the start of real-time streaming.

Recent(u32)

Show the N most recent history entries.

Implementations

impl StreamMode

pub fn returns_history(self) -> bool

Whether this mode produces a multi-line history dump rather than a simple SUCCESS: acknowledgement.

Trait Implementations

impl Clone for StreamMode

fn clone(&self) -> StreamMode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for StreamMode

impl Debug for StreamMode

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

Formats the value using the given formatter.

impl Display for StreamMode

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

Formats the value using the given formatter.

impl Eq for StreamMode

impl FromStr for StreamMode

fn from_str(input: &str) -> Result<Self, Self::Err>

Parse a stream mode string: on, off, all, on all, or a number.

type Err = ParseStreamModeError

The associated error which can be returned from parsing.

impl PartialEq for StreamMode

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for StreamMode