Struct termcolor::Buffer

[+] Show declaration

pub struct Buffer(_);

[−] 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).

Methods

impl Buffer[−]

Important traits for Buffer

impl Write for Buffer

pub fn no_color() -> Buffer[−]

Create a buffer that drops all color information.

Important traits for Buffer

impl Write for Buffer

pub fn ansi() -> Buffer[−]

Create a buffer that uses ANSI escape sequences.

pub fn is_empty(&self) -> bool[−]

Returns true if and only if this buffer is empty.

pub fn len(&self) -> usize[−]

Returns the length of this buffer in bytes.

pub fn clear(&mut self)[−]

Clears this buffer.

pub fn into_inner(self) -> Vec<u8>[−]

Consume this buffer and return the underlying raw data.

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

pub fn as_slice(&self) -> &[u8][−]

Return the underlying data of the buffer.

pub fn as_mut_slice(&mut self) -> &mut [u8][−]

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

Trait Implementations

impl WriteColor for Buffer[+]

[+] 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.

impl Write for Buffer[+]

[+] Show hidden undocumented items

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, Error>[−]

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

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

Attempts to write an entire buffer into this writer.

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

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

fn by_ref(&mut self) -> &mut Self[−]

Creates a "by reference" adaptor for this instance of Write.