Struct terminal_io::TerminalDuplexer

pub struct TerminalDuplexer<Inner: Duplex> { /* fields omitted */ }

A wrapper around a Read + Write which adds minimal terminal support.

Implementations

impl<Inner: Duplex + AsUnsafeReadWriteHandle> TerminalDuplexer<Inner>

pub fn with_handle(inner: Inner) -> Self

Wrap a TerminalDuplex around the given stream, autodetecting terminal properties using its AsUnsafeHandle implementation.

pub fn into_inner(self) -> Inner

Consume self and return the inner stream.

impl<Inner: Duplex + Read + Write> TerminalDuplexer<Inner>

pub fn generic(inner: Inner) -> Self

Wrap a TerminalReader around the given stream, using conservative terminal properties.

Trait Implementations

impl<Inner: Duplex + AsRawReadWriteFd> AsRawReadWriteFd for TerminalDuplexer<Inner>

fn as_raw_read_fd(&self) -> RawFd

Extracts the raw file descriptor for reading.

fn as_raw_write_fd(&self) -> RawFd

Extracts the raw file descriptor for writing.

impl<Inner: Debug + Duplex> Debug for TerminalDuplexer<Inner>

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

Formats the value using the given formatter.

impl<Inner: Duplex> Duplex for TerminalDuplexer<Inner>

impl<Inner: Duplex + HalfDuplex> DuplexTerminal for TerminalDuplexer<Inner>

fn is_terminal(&self) -> bool

Test whether both the input stream and output streams are connected to terminals.

impl<Inner: Duplex + Read + Write> Read for TerminalDuplexer<Inner>

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

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

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

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>

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

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

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

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

Read the exact number of bytes required to fill buf.

pub unsafe fn initializer(&self) -> Initializer

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

Determines if this Reader can work with buffers of uninitialized memory.

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

Creates a "by reference" adaptor for this instance of Read.

pub fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an Iterator over its bytes.

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

Creates an adaptor which will chain this stream with another.

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

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

impl<Inner: Duplex + Read + Write> ReadTerminal for TerminalDuplexer<Inner>

fn is_line_by_line(&self) -> bool

Test whether the input is being sent a line at a time.

fn is_input_terminal(&self) -> bool

Test whether the input is connected to a terminal.

impl<Inner: Duplex> Terminal for TerminalDuplexer<Inner>

impl<Inner: Duplex + Read + Write> Write for TerminalDuplexer<Inner>

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

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

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

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

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

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<()>

Attempts to write an entire buffer into this writer.

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

🔬 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<()>

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

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

Creates a "by reference" adaptor for this instance of Write.

impl<Inner: Duplex + Read + Write> WriteTerminal for TerminalDuplexer<Inner>

fn color_support(&self) -> TerminalColorSupport

Test whether this output stream supports color control codes.

fn color_preference(&self) -> bool

Test whether the user has indicated a preference for color output by default. Respects the NO_COLOR environment variable where applicable.

fn is_output_terminal(&self) -> bool

Test whether the output is connected to a terminal.

fn color_default(&self) -> bool

Test whether color should be used on this terminal by default. This includes both whether color is supported and whether the user has not indicated a preference otherwise.