Enum UseAnsiColoring

pub enum UseAnsiColoring {
    Auto,
    True,
    False,
}

Variants

Auto

True

False

Implementations

impl UseAnsiColoring

pub fn get(self, engine_state: &EngineState) -> bool

Determines whether ANSI colors should be used.

This method evaluates the UseAnsiColoring setting and considers environment variables (FORCE_COLOR, NO_COLOR, and CLICOLOR) when the value is set to Auto. The configuration value (UseAnsiColoring) takes precedence over environment variables, as it is more direct and internally may be modified to override ANSI coloring behavior.

Most users should have the default value Auto which allows the environment variables to control ANSI coloring. However, when explicitly set to True or False, the environment variables are ignored.

Behavior based on UseAnsiColoring:

• True: Forces ANSI colors to be enabled, ignoring terminal support and environment variables.
• False: Disables ANSI colors completely.
• Auto: Determines whether ANSI colors should be used based on environment variables and terminal support.

When set to Auto, the following environment variables are checked in order:

1. FORCE_COLOR: If set, ANSI colors are always enabled, overriding all other settings.
2. NO_COLOR: If set, ANSI colors are disabled, overriding CLICOLOR and terminal checks.
3. CLICOLOR: If set, its value determines whether ANSI colors are enabled (1 for enabled, 0 for disabled).

If none of these variables are set, ANSI coloring is enabled only if the standard output is a terminal.

By prioritizing the UseAnsiColoring value, we ensure predictable behavior and prevent conflicts with internal overrides that depend on this configuration.

Trait Implementations

impl Clone for UseAnsiColoring

fn clone(&self) -> UseAnsiColoring

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UseAnsiColoring

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

Formats the value using the given formatter.

impl Default for UseAnsiColoring

fn default() -> UseAnsiColoring

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for UseAnsiColoring

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<bool> for UseAnsiColoring

fn from(value: bool) -> Self

Converts to this type from the input type.

impl FromValue for UseAnsiColoring

fn from_value(v: Value) -> Result<Self, ShellError>

Loads a value from a Value.

fn expected_type() -> Type

Expected Value type.

impl IntoValue for UseAnsiColoring

fn into_value(self, span: Span) -> Value

Converts the given value to a Value.

impl PartialEq for UseAnsiColoring

fn eq(&self, other: &UseAnsiColoring) -> 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 Serialize for UseAnsiColoring

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for UseAnsiColoring

impl Eq for UseAnsiColoring

impl StructuralPartialEq for UseAnsiColoring