Enum TerminalMode 

pub enum TerminalMode {
    Full,
    Basic,
    None,
}

Terminal capability mode for streaming output.

Determines what level of ANSI escape sequences are appropriate for the current output destination.

Variants

Full

Full ANSI support: cursor positioning, colors, all escapes

Used when stdout is a TTY with capable terminal (xterm, vt100, etc.)

Basic

Basic TTY: colors without cursor positioning

Used when:

• TERM=dumb (basic terminal with color support)
• Terminal type is unknown but TTY is detected

None

Non-TTY output: no ANSI sequences

Used when:

• Output is piped (ralph | tee log.txt)
• Output is redirected (ralph > output.txt)
• CI environment (no TTY detected)
• NO_COLOR=1 is set

Implementations

impl TerminalMode

pub fn detect() -> Self

Detect the current terminal mode from environment.

This checks:

1. NO_COLOR environment variable (respects user preference)
2. CLICOLOR_FORCE (forces colors even in non-TTY)
3. CLICOLOR (macOS color disable)
4. TERM environment variable for capability detection
5. Whether stdout is a terminal using IsTerminal trait

Environment Variables

• NO_COLOR=1: Disables all ANSI output
• NO_COLOR=0 or unset: No effect
• CLICOLOR_FORCE=1: Forces colors even in non-TTY
• CLICOLOR_FORCE=0 or unset: No effect
• CLICOLOR=0: Disables colors on macOS
• CLICOLOR=1 or unset: No effect on macOS
• TERM=xterm-256color: Full ANSI support
• TERM=dumb: Basic TTY with colors but no cursor positioning
• TERM=vt100, TERM=screen: Full ANSI support

Returns

• Full: stdout is TTY with capable terminal
• Basic: stdout is TTY but terminal is basic or TERM is unknown
• None: stdout is not a TTY or colors are disabled

Examples

use ralph::json_parser::TerminalMode;

let mode = TerminalMode::detect();
match mode {
    TerminalMode::Full => println!("Full terminal support"),
    TerminalMode::Basic => println!("Basic terminal (colors only)"),
    TerminalMode::None => println!("Non-TTY output"),
}

Trait Implementations

impl Clone for TerminalMode

fn clone(&self) -> TerminalMode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TerminalMode

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

Formats the value using the given formatter.

impl Default for TerminalMode

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for TerminalMode

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

impl Eq for TerminalMode

impl StructuralPartialEq for TerminalMode