Struct ShouldColorize

pub struct ShouldColorize { /* private fields */ }

A flag for whether coloring should occur.

Implementations

impl ShouldColorize

pub fn from_env() -> Self

Reads environment variables and checks if output is a tty to determine whether colorization should be used or not. CLICOLOR_FORCE takes highest priority, followed by NO_COLOR, followed by CLICOLOR combined with tty check.

pub fn should_colorize(&self) -> bool

Returns if the current coloring is expected.

pub fn set_override(&self, override_colorize: bool)

Use this to force colored to ignore the environment and always/never colorize

pub fn unset_override(&self)

Remove the manual override and let the environment decide if it’s ok to colorize

Trait Implementations

impl Default for ShouldColorize

fn default() -> ShouldColorize

Returns the “default value” for a type.