Struct AnsiWriter 

pub struct AnsiWriter<W: Write + AnsiPreference> { /* private fields */ }

A Writer that writes styled output to an inner Write using a configurable default Ansi instance.

Note: only calls to this Writer’s write_fmt() method will have the default ANSI styling applied. Calls to any other Write methods are unaffected.

Implementations

impl<W: Write + AnsiPreference> AnsiWriter<W>

pub fn new(writer: W, ansi: Ansi) -> Self

Creates a new instance with the given Writer and ANSI style

pub fn default(writer: W) -> Self

Creates a new instance with the given Writer, using its preferred ANSI style.

Trait Implementations

impl<W: Write + AnsiPreference> AnsiPreference for AnsiWriter<W>

fn is_ansi_preferred(&self) -> bool

Determines if this Writer prefers to enable ANSI styles in its output.

fn is_ansi_forced(&self) -> bool

Determines if ANSI codes should be enabled because theFORCE_COLOR env variable has been set.

fn is_ansi_banned(&self) -> bool

Determines if ANSI codes should be disabled because theNO_COLOR env variable has been set.

fn preferred_ansi(&self) -> Ansi

Creates an Ansi intended to be used to enable/disable ANSI styles in a Writer.

impl<W: Write + AnsiPreference> AnsiWrite for AnsiWriter<W>

fn ansi(&self) -> Ansi

Gets this Writer’s default Ansi style.

fn set_ansi(&mut self, ansi: Ansi)

Sets this Writer’s default Ansi style.

fn is_no_ansi(&self) -> bool

Determines whether this Writer’s default Ansi style prohibits writing of all nested ANSI styles.

fn no_ansi(&mut self)

Sets this Writer’s default Ansi style such that rendering of nested ANSI styles during subsequent writes is disabled.

fn is_all_ansi(&self) -> bool

Determines whether this Writer’s default Ansi style allows writing of all nested ANSI styles.

fn all_ansi(&mut self)

Sets this Writer’s default Ansi style such that rendering of nested ANSI styles during subsequent writes is enabled.

fn auto_ansi(&mut self)

Sets this Writer’s default Ansi style to its preferred_ansi(), such that rendering of nested ANSI styles during subsequent writes is enabled/disabled.

impl<W: Write + AnsiPreference> Write for AnsiWriter<W>

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

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

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

Writes a buffer into this writer, returning how many bytes were written.

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

Flushes 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 is_write_vectored(&self) -> bool

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

Determines if this Writer has an efficient write_vectored implementation.

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

Attempts to write an entire buffer into this writer.

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.

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

where Self: Sized,

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