Struct StreamWriter

pub struct StreamWriter<W: WriteStreamMessage> { /* private fields */ }

Writes messages to a stream, with flow control.

The signal contained

Implementations

impl<W> StreamWriter<W>

where W: WriteStreamMessage,

pub fn is_dropped(&self) -> Result<bool, ShellError>

Check if the stream was dropped from the other end. Recommended to do this before calling .write(), especially in a loop.

pub fn write(&mut self, data: impl Into<StreamData>) -> Result<(), ShellError>

Write a single piece of data to the stream.

Error if something failed with the write, or if .end() was already called previously.

pub fn write_all<T>( &mut self, data: impl IntoIterator<Item = T>, ) -> Result<bool, ShellError>

where T: Into<StreamData>,

Write a full iterator to the stream. Note that this doesn’t end the stream, so you should still call .end().

If the stream is dropped from the other end, the iterator will not be fully consumed, and writing will terminate.

Returns Ok(true) if the iterator was fully consumed, or Ok(false) if a drop interrupted the stream from the other side.

pub fn end(&mut self) -> Result<(), ShellError>

End the stream. Recommend doing this instead of relying on Drop so that you can catch the error.

Trait Implementations

impl<W: Debug + WriteStreamMessage> Debug for StreamWriter<W>

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

Formats the value using the given formatter.

impl<W> Drop for StreamWriter<W>

where W: WriteStreamMessage,

fn drop(&mut self)

Executes the destructor for this type.