Enum StreamEvent 

pub enum StreamEvent {
    Chunk(Chunk),
    Gap,
    Eof,
    ReadError(StreamReadError),
}

Event emitted by an output stream backend.

Stream backends send these events to communicate raw process output, deliberate loss of output when a bounded buffer cannot keep up, and the terminal end-of-stream marker.

Variants

Chunk(Chunk)

Bytes read from the underlying stdout or stderr stream.

Gap

Marker indicating that one or more chunks were skipped.

This can be emitted when a lossy backend drops buffered output for a slow consumer. Line parsers use it to discard any partially accumulated line so data from before and after the gap is not joined into a line that never existed in the source stream.

Eof

End of the underlying stdout or stderr stream.

This is the terminal event for the stream. After it is emitted, no more events are expected.

ReadError(StreamReadError)

The underlying stdout or stderr stream failed while being read.

This is terminal, but distinct from EOF because the stream did not end cleanly.

Implementations

impl StreamEvent

pub fn chunk(chunk: impl Into<Chunk>) -> Self

Convenience constructor for StreamEvent::Chunk.

Trait Implementations

impl Clone for StreamEvent

fn clone(&self) -> StreamEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamEvent

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

Formats the value using the given formatter.

impl PartialEq for StreamEvent

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for StreamEvent

impl StructuralPartialEq for StreamEvent