Enum ColorWhen 

pub enum ColorWhen {
    Off,
    Auto,
    Always,
}

Caller-facing text color policy.

Variants

Off

Never emit ANSI color.

Auto

Emit ANSI color only when the output sink supports it.

Always

Always emit ANSI color.

Implementations

impl ColorWhen

pub fn parse(s: &str) -> Result<Self, RenderError>

Parse text color policy from user-provided text.

pub fn resolve(self, output_is_terminal: bool) -> TextColorMode

Resolve the caller-facing policy into a renderer-facing mode.

Trait Implementations

impl Clone for ColorWhen

fn clone(&self) -> ColorWhen

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ColorWhen

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

Formats the value using the given formatter.

impl Default for ColorWhen

fn default() -> ColorWhen

Returns the “default value” for a type.

impl Display for ColorWhen

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

Formats the value using the given formatter.

impl FromStr for ColorWhen

type Err = RenderError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for ColorWhen

fn eq(&self, other: &ColorWhen) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for ColorWhen

impl Eq for ColorWhen

impl StructuralPartialEq for ColorWhen