Struct Format

pub struct Format<'a>(/* private fields */);

A collection of ANSI Attributes that can be applied to formatting or textual elements.

This will disable itself if the environment variable NOCOLOR or NO_COLOR is defined and set to some truthy value.

Implementations

impl<'a> Format<'a>

pub const fn from_slice(attributes: &'a [Attribute]) -> Self

Constructs a Format object from a slice containing Attribute instances.

pub const fn wrap<'b>( &'a self, display: &'b dyn Display, ) -> FormatDisplay<'a, 'b>

Wraps a formatted Display element into a FormatDisplay that will automatically toggle the ANSI formatting before displaying the element, and then follow it up with a fmt::RESET.

Parameters

• display - the element to display

pub fn optimize_for<W>(self, writer: &W) -> Self

where W: Write + IsTerminal,

Computes and returns the optimal format for the specified writer

This will disable formatting if the writer does not support ANSI formatting (determined by checking IsTerminal)

Parameters

• writer - the writer to write to

Trait Implementations

impl Default for Format<'_>

fn default() -> Self

Returns the “default value” for a type.

impl<'a> Display for Format<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.