Enum wbuf::Output

pub enum Output {
    Standard(Stdout),
    Memory(Cursor<Vec<u8>>),
    File(File),
}

Output buffer wrapper type. Wraps stdout, a write-only memory Cursor, or a writeable file buffer.

Variants

Standard(Stdout)

Memory(Cursor<Vec<u8>>)

File(File)

Methods

impl Output

pub fn stdout() -> Self

Returns an Output wrapping stdout.

pub fn memory() -> Self

Returns an Output wrapping a Cursor.

pub fn file(path: &str) -> Result<Self>

Returns an Output wrapping a writeable file.

pub fn from_arg(arg: Option<&str>) -> Result<Self>

Returns either a wrapped file buffer, or stdin, depending on the argument passed in.

The function selects the buffer following these rules:

• No value, or the a literal "-" returns stdin.
• Any other value returns a wrapped file buffer. The file is opened with std::fs::OpenOptions, therefore the parent folder (or the file itself, if it already exists) is required to be writable for the operation to succeed.

Trait Implementations

impl Write for Output

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

Writes data into the underlying buffer.

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

Flushes the buffer.

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

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

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

Attempts to write an entire buffer 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" adaptor for this instance of Write.