Struct terminal_io::TerminalReader

pub struct TerminalReader<Inner: Read> { /* fields omitted */ }

A wrapper around a Read which adds minimal terminal support.

Implementations

impl<Inner: Read + AsUnsafeHandle> TerminalReader<Inner>

pub fn with_handle(inner: Inner) -> Self

Wrap a TerminalReader 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: Read> TerminalReader<Inner>

pub fn generic(inner: Inner) -> Self

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

Trait Implementations

impl<Inner: Read + AsRawFd> AsRawFd for TerminalReader<Inner>

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl<Inner: Debug + Read> Debug for TerminalReader<Inner>

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

Formats the value using the given formatter.

impl<Inner: Read> Read for TerminalReader<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: Read> ReadTerminal for TerminalReader<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: Read> Terminal for TerminalReader<Inner>