Struct terminal_io::TerminalWriter

pub struct TerminalWriter<Inner: Write> { /* private fields */ }

A wrapper around a Write which adds minimal terminal support.

Implementations

impl<Inner: Write + AsGrip> TerminalWriter<Inner>

pub fn with_handle(inner: Inner) -> Self

Wrap a TerminalWriter around the given stream, autodetecting terminal properties using its AsGrip implementation.

pub fn from(
    inner: Inner,
    is_terminal: bool,
    color_support: TerminalColorSupport,
    color_preference: bool
) -> Self

Wrap a TerminalWriter around the given stream, using the given terminal properties.

impl<Inner: Write> TerminalWriter<Inner>

pub fn generic(inner: Inner) -> Self

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

pub fn into_inner(self) -> Inner

Consume self and return the inner stream.

Trait Implementations

impl<Inner: Write + AsFd> AsFd for TerminalWriter<Inner>

fn as_fd(&self) -> BorrowedFd<'_>

Borrows the file descriptor.

impl<Inner: Write + AsRawFd> AsRawFd for TerminalWriter<Inner>

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl<Inner: Debug + Write> Debug for TerminalWriter<Inner>

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

Formats the value using the given formatter.

impl<Inner: Write> Write for TerminalWriter<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.

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

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

impl<Inner: Write> WriteTerminal for TerminalWriter<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.

impl<Inner: Write> Terminal for TerminalWriter<Inner>