Struct CapabilityOverride 

pub struct CapabilityOverride {

    pub color_depth: Option<ColorDepth>,
    pub unicode_box_drawing: Option<bool>,
    pub unicode_emoji: Option<bool>,
    pub double_width: Option<bool>,
    pub sync_output: Option<bool>,
    pub osc8_hyperlinks: Option<bool>,
    pub scroll_region: Option<bool>,
    pub in_tmux: Option<bool>,
    pub in_screen: Option<bool>,
    pub in_zellij: Option<bool>,
    pub in_wezterm_mux: Option<bool>,
    pub kitty_keyboard: Option<bool>,
    pub focus_events: Option<bool>,
    pub bracketed_paste: Option<bool>,
    pub mouse_sgr: Option<bool>,
    pub osc52_clipboard: Option<bool>,
}

Override specification for terminal capabilities.

Boolean fields use Option<bool>:

• Some(true) - Force capability ON
• Some(false) - Force capability OFF
• None - Don’t override (use base or previous override)

color_depth uses Option<ColorDepth> with the same None inheritance semantics.

Fields

color_depth: Option<ColorDepth>

unicode_box_drawing: Option<bool>

unicode_emoji: Option<bool>

double_width: Option<bool>

sync_output: Option<bool>

osc8_hyperlinks: Option<bool>

scroll_region: Option<bool>

in_tmux: Option<bool>

in_screen: Option<bool>

in_zellij: Option<bool>

in_wezterm_mux: Option<bool>

kitty_keyboard: Option<bool>

focus_events: Option<bool>

bracketed_paste: Option<bool>

mouse_sgr: Option<bool>

osc52_clipboard: Option<bool>

Implementations

impl CapabilityOverride

pub const fn new() -> Self

Create a new empty override (no fields overridden).

pub const fn dumb() -> Self

Create an override that disables all capabilities (dumb terminal).

pub const fn modern() -> Self

Create an override that enables all capabilities (modern terminal).

pub const fn tmux() -> Self

Create an override that simulates running inside tmux.

The transport overlay preserves the base terminal’s color depth. Use TerminalCapabilities::tmux when a concrete 256-color tmux profile is required.

pub const fn color_depth(self, value: Option<ColorDepth>) -> Self

Override maximum color fidelity.

pub const fn unicode_box_drawing(self, value: Option<bool>) -> Self

Override Unicode box drawing support.

pub const fn unicode_emoji(self, value: Option<bool>) -> Self

Override emoji glyph support.

pub const fn double_width(self, value: Option<bool>) -> Self

Override double-width glyph support.

pub const fn sync_output(self, value: Option<bool>) -> Self

Override synchronized output support.

pub const fn osc8_hyperlinks(self, value: Option<bool>) -> Self

Override OSC 8 hyperlinks support.

pub const fn scroll_region(self, value: Option<bool>) -> Self

Override scroll region support.

pub const fn in_tmux(self, value: Option<bool>) -> Self

Override tmux detection.

pub const fn in_screen(self, value: Option<bool>) -> Self

Override GNU screen detection.

pub const fn in_zellij(self, value: Option<bool>) -> Self

Override Zellij detection.

pub const fn in_wezterm_mux(self, value: Option<bool>) -> Self

Override WezTerm mux detection.

pub const fn kitty_keyboard(self, value: Option<bool>) -> Self

Override Kitty keyboard protocol support.

pub const fn focus_events(self, value: Option<bool>) -> Self

Override focus events support.

pub const fn bracketed_paste(self, value: Option<bool>) -> Self

Override bracketed paste mode support.

pub const fn mouse_sgr(self, value: Option<bool>) -> Self

Override SGR mouse protocol support.

pub const fn osc52_clipboard(self, value: Option<bool>) -> Self

Override OSC 52 clipboard support.

pub const fn is_empty(&self) -> bool

Check if any capability is overridden.

pub fn apply_to(&self, caps: TerminalCapabilities) -> TerminalCapabilities

Apply this override on top of base capabilities.

Trait Implementations

impl Clone for CapabilityOverride

fn clone(&self) -> CapabilityOverride

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CapabilityOverride

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

Formats the value using the given formatter.

impl Default for CapabilityOverride

fn default() -> CapabilityOverride

Returns the “default value” for a type.