colored::control

Struct ShouldColorize

source
pub struct ShouldColorize {
    clicolor: bool,
    clicolor_force: Option<bool>,
    has_manual_override: AtomicBool,
    manual_override: AtomicBool,
}
Expand description

A flag for whether coloring should occur.

Fields§

§clicolor: bool§clicolor_force: Option<bool>§has_manual_override: AtomicBool§manual_override: AtomicBool

Implementations§

source§

impl ShouldColorize

source

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.

source

pub fn should_colorize(&self) -> bool

Returns if the current coloring is expected.

source

pub fn set_override(&self, override_colorize: bool)

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

source

pub fn unset_override(&self)

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

source

fn normalize_env(env_res: Result<String, VarError>) -> Option<bool>

source

fn resolve_clicolor_force( no_color: Result<String, VarError>, clicolor_force: Result<String, VarError>, ) -> Option<bool>

Trait Implementations§

source§

impl Default for ShouldColorize

source§

fn default() -> ShouldColorize

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.