Enum clio::Output

pub enum Output {
    Stdout(Stdout),
    Pipe(OsString, File),
    File(OsString, File),
}

An enum that represents a command line output stream, either std out or a file

Variants

Stdout(Stdout)

Pipe(OsString, File)

File(OsString, File)

Implementations

impl Output

pub fn new<S: AsRef<OsStr>>(path: S) -> Result<Self>

Contructs a new output either by opening/creating the file or for ‘-’ returning stdout

pub fn try_from_os_str(path: &OsStr) -> Result<Self, OsString>

Contructs a new output either by opening/creating the file or for ‘-’ returning stdout

The error is converted to a OsString so that stuctopt can show it to the user.

It is recomended that you use TryFrom::try_from and clap 3.0 instead.

pub fn finish(self) -> Result<()>

Syncs the file to disk or closes any HTTP connections and returns any errors or on the file if a regular file

pub fn lock<'a>(&'a mut self) -> Box<dyn Write + 'a>

If the output is std out locks it. usefull in multithreaded context to write lines consistently

Examples

let mut file = clio::Output::new("-")?;

writeln!(file.lock(), "hello world")?;

Trait Implementations

impl Debug for Output

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

Formats the value using the given formatter.

impl Display for Output

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

Formats the value using the given formatter.

impl Seek for Output

fn seek(&mut self, pos: SeekFrom) -> IoResult<u64>

Seek to an offset, in bytes, in a stream.

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

Rewind to the beginning of a stream.

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

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

Returns the length of this stream (in bytes).

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

Returns the current seek position from the start of the stream.

impl TryFrom<&'_ OsStr> for Output

type Error = Error

The type returned in the event of a conversion error.

fn try_from(file_name: &OsStr) -> Result<Self>

Performs the conversion.

impl Write for Output

fn flush(&mut self) -> IoResult<()>

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

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

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

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, fmt: Arguments<'_>) -> Result<(), Error>

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

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

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