Struct termcolor::Buffer[][src]

pub struct Buffer(BufferInner);
Expand description

Write colored text to memory.

Buffer is a platform independent abstraction for printing colored text to an in memory buffer. When the buffer is printed using a BufferWriter, the color information will be applied to the output device (a tty on Unix and a console on Windows).

A Buffer is typically created by calling the BufferWriter.buffer method, which will take color preferences and the environment into account. However, buffers can also be manually created using no_color, ansi or console (on Windows).

Tuple Fields

0: BufferInner

Implementations

Create a new buffer with the given color settings.

Create a buffer that drops all color information.

Create a buffer that uses ANSI escape sequences.

Returns true if and only if this buffer is empty.

Returns the length of this buffer in bytes.

Clears this buffer.

Consume this buffer and return the underlying raw data.

On Windows, this unrecoverably drops all color information associated with the buffer.

Return the underlying data of the buffer.

Return the underlying data of the buffer as a mutable slice.

Trait Implementations

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

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

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

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

Determines if this Writer has an efficient write_vectored implementation. Read more

Attempts to write an entire buffer into this writer. Read more

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

Attempts to write multiple buffers into this writer. Read more

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

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

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

Set the color settings of the writer. Read more

Reset the current color settings to their original settings. Read more

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. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Performs the conversion.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.