Struct termcolor::StandardStream

[+] Show declaration

pub struct StandardStream { /* fields omitted */ }

[−] Expand description

Satisfies io::Write and WriteColor, and supports optional coloring to either of the standard output streams, stdout and stderr.

Implementations

impl StandardStream[−]

pub fn stdout(choice: ColorChoice) -> StandardStream[−]

Create a new StandardStream with the given color preferences that writes to standard output.

On Windows, if coloring is desired and a Windows console could not be found, then ANSI escape sequences are used instead.

The specific color/style settings can be configured when writing via the WriteColor trait.

pub fn stderr(choice: ColorChoice) -> StandardStream[−]

Create a new StandardStream with the given color preferences that writes to standard error.

On Windows, if coloring is desired and a Windows console could not be found, then ANSI escape sequences are used instead.

The specific color/style settings can be configured when writing via the WriteColor trait.

pub fn lock(&self) -> StandardStreamLock<'_>[−]

Lock the underlying writer.

The lock guard returned also satisfies io::Write and WriteColor.

This method is not reentrant. It may panic if lock is called while a StandardStreamLock is still alive.

Trait Implementations

impl Write for StandardStream[+]

[+] Show hidden undocumented items

fn write(&mut self, b: &[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.

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

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

pub 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.

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

Attempts to write an entire buffer into this writer.

pub 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.

pub fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<(), Error>[−]

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 WriteColor for StandardStream[+]

[+] Show hidden undocumented items

fn supports_color(&self) -> bool[−]

Returns true if and only if the underlying writer supports colors.

fn set_color(&mut self, spec: &ColorSpec) -> Result<()>[−]

Set the color settings of the writer.

fn reset(&mut self) -> Result<()>[−]

Reset the current color settings to their original settings.

fn is_synchronous(&self) -> bool[−]

Returns true if and only if the underlying writer must synchronously interact with an end user’s device in order to control colors. By default, this always returns false.