[][src]Struct termcolor::Buffer

pub struct Buffer(_);

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


impl Buffer[src]

pub fn no_color() -> Buffer[src]

Create a buffer that drops all color information.

pub fn ansi() -> Buffer[src]

Create a buffer that uses ANSI escape sequences.

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

Returns true if and only if this buffer is empty.

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

Returns the length of this buffer in bytes.

pub fn clear(&mut self)[src]

Clears this buffer.

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

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][src]

Return the underlying data of the buffer.

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

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

Trait Implementations

impl Write for Buffer[src]

impl WriteColor for Buffer[src]

Auto Trait Implementations

impl RefUnwindSafe for Buffer

impl Send for Buffer

impl Sync for Buffer

impl Unpin for Buffer

impl UnwindSafe for Buffer

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized

impl<T> Borrow<T> for T where
    T: ?Sized

impl<T> BorrowMut<T> for T where
    T: ?Sized

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.