Struct ColorAccumulator

pub struct ColorAccumulator { /* private fields */ }

A facility for creating visually inspectable representations of colored output so they can be easily tested.

A new color is represented as {style} and a reset is represented by {/}.

Attributes are printed in this order:

• Foreground color as fg:Color
• Background color as bg:Color
• Bold as bold
• Underline as underline
• Intense as bright

For example, the style “intense, bold red foreground” would be printed as:

{fg:Red bold intense}

Since this implementation attempts to make it possible to faithfully understand what real WriteColor implementations would do, it tries to approximate the contract in the WriteColor trait: “Subsequent writes to this write will use these settings until either reset is called or new color settings are set.”)

• If set_color is called with a style, {...} is emitted containing the color attributes.
• If set_color is called with no style, {/} is emitted
• If reset is called, {/} is emitted

Implementations

impl ColorAccumulator

pub fn new() -> ColorAccumulator

pub fn to_string(self) -> String

Trait Implementations

impl Write for ColorAccumulator

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

where Self: Sized,

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

impl WriteColor for ColorAccumulator

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.

fn set_hyperlink(&mut self, _link: &HyperlinkSpec<'_>) -> Result<(), Error>

Set the current hyperlink of the writer.

fn supports_hyperlinks(&self) -> bool

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