# Struct termcolor::Ansi

source · [−]

    pub struct Ansi<W>(_);

Expand description

Satisfies `WriteColor` using standard ANSI escape sequences.

## Implementations

source

### impl<W: Write> Ansi<W>

source

#### pub fn new(wtr: W) -> Ansi<W>ⓘNotable traits for Ansi<W>`impl<W: Write> Write for Ansi<W>`

Create a new writer that satisfies `WriteColor` using standard ANSI escape sequences.

source

#### pub fn into_inner(self) -> W

Consume this `Ansi` value and return the inner writer.

source

#### pub fn get_ref(&self) -> &W

Return a reference to the inner writer.

source

#### pub fn get_mut(&mut self) -> &mut W

Return a mutable reference to the inner writer.

## Trait Implementations

source

### impl<W: Write> Write for Ansi<W>

source

#### fn write(&mut self, buf: &[u8]) -> Result<usize>

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

source

#### fn flush(&mut self) -> Result<()>

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

1.36.0 · source

#### fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

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

source

#### fn is_write_vectored(&self) -> bool

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

Determines if this `Write`r has an efficient `write_vectored` implementation. Read more

1.0.0 · source

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

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

source

#### fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

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

Attempts to write multiple buffers into this writer. Read more

1.0.0 · source

#### fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<(), Error>

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

1.0.0 · source

#### fn by_ref(&mut self) -> &mut Self

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

source

### impl<W: Write> WriteColor for Ansi<W>

source

#### fn supports_color(&self) -> bool

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

source

#### fn set_color(&mut self, spec: &ColorSpec) -> Result<()>

Set the color settings of the writer. Read more

source

#### fn reset(&mut self) -> Result<()>

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

source

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

## Auto Trait Implementations

### impl<W> RefUnwindSafe for Ansi<W> where
W: RefUnwindSafe,

### impl<W> Send for Ansi<W> where
W: Send,

### impl<W> Sync for Ansi<W> where
W: Sync,

### impl<W> Unpin for Ansi<W> where
W: Unpin,

### impl<W> UnwindSafe for Ansi<W> where
W: UnwindSafe,

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