Struct StreamOptions 

pub struct StreamOptions {
    pub offset: u64,
    pub reconnect: bool,
    pub max_reconnects: u32,
    pub error_on_gap: bool,
    pub idle_timeout: Duration,
}

How a stream should behave. See ExecHandle::stream_with.

Fields

offset: u64

The byte to start at. Non-zero resumes a stream a previous process was reading.

reconnect: bool

Whether to reconnect after a cut. false ends the stream at the cut instead, which is what a caller doing its own reconnection wants.

max_reconnects: u32

How many reconnects before giving up. A bound rather than forever, because a stream that drops every time is a condition a caller needs reported.

error_on_gap: bool

Turns a gap into an error instead of an event. What a caller that must have complete output wants.

idle_timeout: Duration

How long the body may be silent before the connection is treated as dead.

Trait Implementations

impl Clone for StreamOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamOptions

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

Formats the value using the given formatter.

impl Default for StreamOptions

fn default() -> Self

Returns the “default value” for a type.