# Struct termcolor::BufferWriter

source · [−]

    pub struct BufferWriter { /* private fields */ }

Expand description

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

source

### impl BufferWriter

source

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

source

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

source

#### pub fn separator(&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`.

source

#### pub fn buffer(&self) -> BufferⓘNotable traits for Buffer `impl Write for 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.

source

#### pub fn print(&self, buf: &Buffer) -> 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.

## Auto Trait Implementations

### impl RefUnwindSafe for BufferWriter

### impl Send for BufferWriter

### impl Sync for BufferWriter

### impl Unpin for BufferWriter

### impl UnwindSafe for BufferWriter

## Blanket Implementations

source

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

source

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more

source

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

const: unstable · source

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

### impl<T> From<T> for T

const: unstable · source

#### fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · source

#### fn into(self) -> U

Calls `U::from(self)`.

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

source

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

#### type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

source

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

const: unstable · source

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.