Enum Profile 

pub enum Profile {
    Disabled,
    Ascii,
    Ansi,
    Ansi256,
    TrueColor,
}

Terminal color capability profile.

Profiles are ordered by increasing capability: Disabled < Ascii < Ansi < Ansi256 < TrueColor. Use this ordering when clamping or choosing the maximum capability discovered from multiple sources.

Variants

Disabled

No styling output at all.

Used for non-TTY output and terminals that should not receive escape sequences. Color conversion returns None; callers that convert whole styles generally drop colors, attributes, underline state, and links.

Ascii

ASCII/no-color profile where text decoration is still allowed.

Color conversion returns None, but higher-level style conversion may preserve non-color SGR attributes such as bold or underline.

Ansi

Standard 16-color ANSI palette.

Color conversion returns the nearest named Color using weighted RGB distance against the xterm palette entries 0..=15.

Ansi256

xterm 256-color palette.

Color conversion returns the nearest Color::Indexed, choosing between the 6×6×6 color cube and grayscale ramp by weighted RGB distance.

TrueColor

24-bit true color.

Color conversion returns the original Color unchanged.

Implementations

impl Profile

pub fn convert(self, color: Color) -> Option<Color>

Downsample a color to fit this profile.

Returns Some(color) when this profile supports color output and None for Profile::Disabled or Profile::Ascii. TrueColor preserves the original value; Ansi256 and Ansi resolve the input to RGB and quantize to the nearest supported palette.

pub fn detect() -> Self

Detect the color profile from the current process environment.

This assumes the output stream is a TTY. For explicit TTY state or deterministic tests, use Profile::detect_from.

pub fn detect_from(env: &Env, is_tty: bool) -> Self

Detect the color profile from an explicit environment snapshot.

is_tty should be true if the output stream is a terminal. A false value clamps to Profile::Disabled unless TTY_FORCE makes the stream act like a TTY or CLICOLOR_FORCE forces color. TERM=dumb and, on non-Windows platforms, an empty TERM start as disabled before other forcing/upgrading rules are applied.

Trait Implementations

impl Clone for Profile

fn clone(&self) -> Profile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Profile

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

Formats the value using the given formatter.

impl Default for Profile

fn default() -> Profile

Returns the “default value” for a type.

impl Hash for Profile

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Profile

fn cmp(&self, other: &Profile) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Profile

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

fn partial_cmp(&self, other: &Profile) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Profile

impl Eq for Profile

impl StructuralPartialEq for Profile