Struct `BufferWriter`

struct BufferWriter { ... }

Writes colored buffers to stdout or stderr.

Writable buffers can be obtained by calling buffer on a BufferWriter.

This writer works with terminals that support ANSI escape sequences or with a Windows console.

It is intended for a BufferWriter to be put in an Arc and written to from multiple threads simultaneously.

Implementations

fn stdout(choice: ColorChoice) -> BufferWriter

Create a new BufferWriter that writes to stdout with the given color preferences.

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 to the buffers themselves.

fn stderr(choice: ColorChoice) -> BufferWriter

Create a new BufferWriter that writes to stderr with the given color preferences.

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 to the buffers themselves.

fn separator(self: &mut Self, sep: Option<Vec<u8>>)

If set, the separator given is printed between buffers. By default, no separator is printed.

The default value is None.

fn buffer(self: &Self) -> Buffer

Creates a new Buffer with the current color preferences.

A Buffer satisfies both io::Write and WriteColor. A Buffer can be printed using the print method.

fn print(self: &Self, buf: &Buffer) -> io::Result<()>

Prints the contents of the given buffer.

It is safe to call this from multiple threads simultaneously. In particular, all buffers are written atomically. No interleaving will occur.

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

fn into(self: Self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of [From]<T> for U chooses to do.