Struct DetectorSettings 

pub struct DetectorSettings<T> { /* private fields */ }

Settings for enabling extra detector features.

Implementations

impl DetectorSettings<NoTerminal>

pub fn new() -> Self

Create a new DetectorSettings.

impl<T> DetectorSettings<T>

pub fn enable_terminfo(self, enable_terminfo: bool) -> Self

Available on crate feature terminfo only.

Enable or disable querying the terminfo database.

pub fn enable_tmux_info(self, enable_tmux_info: bool) -> Self

Enable or disable querying the tmux information if tmux is used.

impl<T> DetectorSettings<T>

where T: QueryTerminal,

pub fn query_terminal<Q>(self, query_terminal: Q) -> DetectorSettings<Q>

Available on crate feature query-detect only.

Query the terminal for true color support using the given query method.

If this option is enabled, the terminal may be put into raw mode while the terminal query is performed and then back into cooked mode afterward. It’s important to prevent other threads from reading or writing to the terminal while this happens because they could conflict with each other.

impl DetectorSettings<DefaultTerminal>

pub fn with_query() -> Result<Self>

Available on crate feature query-detect only.

Create a new DetectorSettings with terminal querying enabled.

If this option is enabled, the terminal may be put into raw mode while the terminal query is performed and then back into cooked mode afterward. It’s important to prevent other threads from reading or writing to the terminal while this happens because they could conflict with each other.

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/override.rs (line 6)

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:?}");
}

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);
    }
}

Trait Implementations

impl<T: Clone> Clone for DetectorSettings<T>

fn clone(&self) -> DetectorSettings<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for DetectorSettings<T>

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

Formats the value using the given formatter.

impl Default for DetectorSettings<NoTerminal>

fn default() -> Self

Returns the “default value” for a type.

impl<T: PartialEq> PartialEq for DetectorSettings<T>

fn eq(&self, other: &DetectorSettings<T>) -> 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<T: Eq> Eq for DetectorSettings<T>

impl<T> StructuralPartialEq for DetectorSettings<T>