Enum TermProfile 

pub enum TermProfile {
    NoTty,
    NoColor,
    Ansi16,
    Ansi256,
    TrueColor,
}

Terminal color profile.

Variants

NoTty

No terminal is attached. This may happen if the output is piped or if the program was not ran from a TTY.

NoColor

Text modifiers may be used, but no colors should be emitted.

Ansi16

16 colors are supported.

Ansi256

256 colors are supported.

TrueColor

Any RGB color is supported.

Implementations

impl TermProfile

pub fn adapt_color<C>(&self, color: C) -> Option<C>

where C: AdaptableColor,

Available on crate feature convert only.

Adapts the color into its nearest compatible variant.

Examples found in repository

examples/convert.rs (line 25)

fn print_color(profile: TermProfile, color: Color) {
    let color = profile.adapt_color(color);
    if let Some(color) = color {
        let style = to_owo_style(Style::new().fg_color(Some(color)));
        println!("{}", color_to_str(&color).style(style));
    } else {
        println!("No color");
    }
}

pub fn adapt_style<S>(&self, style: S) -> S

where S: AdaptableStyle,

Available on crate feature convert only.

Adapts the style into its nearest compatible variant.

Examples found in repository

examples/ratatui_app.rs (line 34)

fn draw(profile: &TermProfile, frame: &mut Frame) {
    let color = Color::Rgb(rand_rgb(), rand_rgb(), rand_rgb());
    let style = profile.adapt_style(Style::new().fg(color));

    frame.render_widget(
        Text::from_iter([
            Line::raw("try using NO_COLOR and FORCE_COLOR to change the output"),
            Line::raw(""),
            Line::styled(
                format!(
                    "random color: {}",
                    style.fg.map(|f| f.to_string()).unwrap_or("N/A".to_string())
                ),
                style,
            ),
        ]),
        frame.area(),
    );
}

impl TermProfile

pub fn detect<T, Q>(output: &T, settings: DetectorSettings<Q>) -> Self

where T: IsTerminal, Q: QueryTerminal,

Detect the output’s profile information.

This is a potentially expensive operation depending on the settings and features enabled. You likely want to run this once and reuse the result throughout your app.

Examples found in repository

examples/detect.rs (line 6)

fn main() {
    let profile = TermProfile::detect(&stdout(), DetectorSettings::with_query().unwrap());
    println!("Detected profile: {profile:?}");
}

examples/ratatui_app.rs (line 12)

fn main() -> io::Result<()> {
    // NOTE: it's important to detect the profile before initializing the terminal since the
    // detection process may affect the terminal state.
    let profile = TermProfile::detect(&stdout(), DetectorSettings::with_query()?);

    let terminal = ratatui::init();
    let result = run(terminal, profile);
    ratatui::restore();
    result
}

examples/convert.rs (line 10)

fn main() {
    let color = parse_input();
    let profile = TermProfile::detect(&stdout(), DetectorSettings::with_query().unwrap());
    println!("Detected profile: {profile:?}");
    print!("Adapted: ");
    print_color(profile, color);
    if profile > TermProfile::Ansi256 {
        print!("ANSI 256: ");
        print_color(TermProfile::Ansi256, color);
    }
    if profile > TermProfile::Ansi16 {
        print!("ANSI 16: ");
        print_color(TermProfile::Ansi16, color);
    }
}

pub fn detect_with_vars(vars: TermVars) -> Self

Detect the output’s profile information using the given variables as the source.

This is a potentially expensive operation depending on the settings and features enabled. You likely want to run this once and reuse the result throughout your app.

Examples found in repository

examples/override.rs (line 8)

fn main() {
    let mut vars = TermVars::from_env(&stdout(), DetectorSettings::with_query().unwrap());
    vars.overrides.force_color = "1".into();
    let profile = TermProfile::detect_with_vars(vars);
    println!("Profile with override: {profile:?}");
}

Trait Implementations

impl Clone for TermProfile

fn clone(&self) -> TermProfile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TermProfile

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

Formats the value using the given formatter.

impl Ord for TermProfile

fn cmp(&self, other: &TermProfile) -> 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 TermProfile

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

fn partial_cmp(&self, other: &TermProfile) -> 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 TermProfile

impl Eq for TermProfile

impl StructuralPartialEq for TermProfile