Struct TerminalCapabilities

Source

pub struct TerminalCapabilities {Show 16 fields
    pub true_color: bool,
    pub colors_256: bool,
    pub unicode_box_drawing: bool,
    pub unicode_emoji: bool,
    pub double_width: bool,
    pub sync_output: bool,
    pub osc8_hyperlinks: bool,
    pub scroll_region: bool,
    pub in_tmux: bool,
    pub in_screen: bool,
    pub in_zellij: bool,
    pub kitty_keyboard: bool,
    pub focus_events: bool,
    pub bracketed_paste: bool,
    pub mouse_sgr: bool,
    pub osc52_clipboard: bool,
    /* private fields */
}

Expand description

Terminal capability model.

This struct describes what features a terminal supports. Use detect to auto-detect from the environment, or basic for a minimal fallback.

§Predefined Profiles

For testing and simulation, use predefined profiles:

modern() - Full-featured modern terminal
xterm_256color() - Standard xterm with 256 colors
xterm() - Basic xterm with 16 colors
vt100() - VT100 terminal (minimal)
dumb() - No capabilities
screen() - GNU Screen
tmux() - tmux multiplexer
kitty() - Kitty terminal

Fields§

§true_color: bool

True color (24-bit RGB) support.

§colors_256: bool

256-color palette support.

§unicode_box_drawing: bool

Unicode box-drawing support.

§unicode_emoji: bool

Emoji glyph support.

§double_width: bool

Double-width glyph support (CJK/emoji).

§sync_output: bool

Synchronized output (DEC mode 2026) to reduce flicker.

§osc8_hyperlinks: bool

OSC 8 hyperlinks support.

§scroll_region: bool

Scroll region support (DECSTBM).

§in_tmux: bool

Running inside tmux.

§in_screen: bool

Running inside GNU screen.

§in_zellij: bool

Running inside Zellij.

§kitty_keyboard: bool

Kitty keyboard protocol support.

§focus_events: bool

Focus event reporting support.

§bracketed_paste: bool

Bracketed paste mode support.

§mouse_sgr: bool

SGR mouse protocol support.

§osc52_clipboard: bool

OSC 52 clipboard support (best-effort, security restricted in some terminals).

Implementations§

Source §

impl TerminalCapabilities

Source

pub fn with_overrides() -> Self

Detect capabilities and apply any active thread-local overrides.

This is the recommended way to get capabilities in code that may be running under test with overrides.

Source

pub fn with_overrides_from(self, base: Self) -> Self

Apply overrides to these capabilities.

Source §

impl TerminalCapabilities

Source

pub const fn profile(&self) -> TerminalProfile

Get the profile identifier for this capability set.

Source

pub fn profile_name(&self) -> Option<&'static str>

Get the profile name as a string.

Returns None for detected capabilities (use profile() to distinguish between profiles).

Source

pub fn from_profile(profile: TerminalProfile) -> Self

Create capabilities from a profile identifier.

Source

pub const fn modern() -> Self

Modern terminal with all features enabled.

Represents terminals like WezTerm, Alacritty, Ghostty, Kitty, iTerm2. All advanced features are enabled.

Source

pub const fn xterm_256color() -> Self

xterm with 256-color support.

Standard xterm-256color profile with common features. No true color, no sync output, no hyperlinks.

Source

pub const fn xterm() -> Self

Basic xterm with 16 colors only.

Minimal xterm without 256-color or advanced features.

Source

pub const fn vt100() -> Self

VT100 terminal (minimal capabilities).

Classic VT100 with basic cursor control, no colors.

Source

pub const fn dumb() -> Self

Dumb terminal with no capabilities.

Alias for basic() with the Dumb profile identifier.

Source

pub const fn screen() -> Self

GNU Screen multiplexer.

Screen with 256 colors but multiplexer-safe settings. Sync output and scroll region disabled for passthrough safety.

Source

pub const fn tmux() -> Self

tmux multiplexer.

tmux with 256 colors and multiplexer detection. Advanced features disabled for passthrough safety.

Source

pub const fn zellij() -> Self

Zellij multiplexer.

Zellij with true color (it has better passthrough than tmux/screen).

Source

pub const fn windows_console() -> Self

Windows Console Host.

Windows Terminal with good color support but some quirks.

Source

pub const fn kitty() -> Self

Kitty terminal.

Kitty with full feature set including keyboard protocol.

Source

pub const fn linux_console() -> Self

Linux console (framebuffer console).

Linux console with no colors and basic features.

Source

pub fn builder() -> CapabilityProfileBuilder

Create a builder for custom capability profiles.

Start with all capabilities disabled and enable what you need.

Source §

impl TerminalCapabilities

Source

pub fn detect() -> Self

Detect terminal capabilities from the environment.

This examines environment variables to determine what features the current terminal supports. When in doubt, capabilities are disabled for safety.

Source

pub const fn basic() -> Self

Create a minimal fallback capability set.

This is safe to use on any terminal, including dumb terminals. All advanced features are disabled.

Source

pub const fn in_any_mux(&self) -> bool

Check if running inside any terminal multiplexer.

This includes tmux, GNU screen, and Zellij.

Source

pub const fn has_color(&self) -> bool

Check if any color support is available.

Source

pub const fn color_depth(&self) -> &'static str

Get the maximum color depth as a string identifier.

Source

pub const fn use_sync_output(&self) -> bool

Whether synchronized output (DEC 2026) should be used.

Disabled in multiplexers because passthrough is unreliable for mode-setting sequences.

Source

pub const fn use_scroll_region(&self) -> bool

Whether scroll-region optimization (DECSTBM) is safe to use.

Disabled in multiplexers due to inconsistent scroll margin handling across tmux, screen, and Zellij.

Source

pub const fn use_hyperlinks(&self) -> bool

Whether OSC 8 hyperlinks should be emitted.

Disabled in tmux and screen because passthrough for OSC sequences is fragile. Zellij (0.39+) has better passthrough but is still disabled by default for safety.

Source

pub const fn use_clipboard(&self) -> bool

Whether OSC 52 clipboard access should be used.

Already gated by mux detection in detect(), but this method provides a consistent policy interface.

Source

pub const fn needs_passthrough_wrap(&self) -> bool

Whether the passthrough wrapping is needed for this environment.

Returns true if running in tmux or screen, which require DCS passthrough for escape sequences to reach the inner terminal. Zellij handles passthrough natively and doesn’t need wrapping.