Enum InputOutput

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

Duplex I/O buffer wrapper type. Wraps stdin/stdout, a read/write Cursor, or a readable/writable file buffer.

Variants

Standard(Stdin, Stdout)

Memory(Cursor<Vec<u8>>)

File(File)

Implementations

impl InputOutput

pub fn stdio() -> InputOutput

Returns an InputOutput wrapping stdin and stdout.

pub fn memory() -> InputOutput

Returns an InputOutput wrapping a Cursor.

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

Returns an InputOutput wrapping a readable and writable file.

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

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 file is required to exist, and be readable and writable for the operation to succeed.

Trait Implementations

impl Read for InputOutput

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

Read from the underlying buffer.

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

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

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

Determines if this Reader has an efficient read_vectored implementation.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Reads all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Reads all bytes until EOF in this source, appending them to buf.

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

Reads the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

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

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

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

Reads the exact number of bytes required to fill cursor.

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

where Self: Sized,

Creates a “by reference” adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R>

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

where Self: Sized,

Creates an adapter which will read at most limit bytes from it.

impl Write for InputOutput

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

Writes into the underlying buffer.

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

Flushes the underlying buffer.

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.