Struct OutputStream 

pub struct OutputStream<'a>(/* private fields */);

A CLAP data stream that can be written to.

This helper struct is designed to work with the standard Write trait.

Implementations

impl<'a> OutputStream<'a>

pub fn from_writer<W>(writer: &'a mut W) -> OutputStream<'a>

where W: Write + 'a,

Creates a new output stream for an existing write implementation.

pub unsafe fn from_raw_mut(raw: &mut clap_ostream) -> &mut OutputStream<'a>

Crates a new output stream for a C FFI-compatible pointer.

Safety

The caller must ensure the given clap_ostream instance is valid.

pub fn as_raw_mut(&mut self) -> &mut clap_ostream

Returns this output stream as a C FFI-compatible pointer.

Trait Implementations

impl Write for OutputStream<'_>

fn write(&mut self, buf: &[u8]) -> Result<usize, Error>

Writes a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<(), Error>

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.