Struct CapabilityProfileBuilder 

pub struct CapabilityProfileBuilder { /* private fields */ }

Builder for custom terminal capability profiles.

Enables fine-grained control over capability configuration for testing and simulation purposes.

Example

use ftui_core::terminal_capabilities::CapabilityProfileBuilder;

let profile = CapabilityProfileBuilder::new()
    .colors_256(true)
    .true_color(true)
    .mouse_sgr(true)
    .bracketed_paste(true)
    .build();

assert!(profile.colors_256);
assert!(profile.true_color);

Implementations

impl CapabilityProfileBuilder

pub fn new() -> Self

Create a new builder with all capabilities disabled.

pub fn from_profile(profile: TerminalProfile) -> Self

Start from an existing profile.

pub fn build(self) -> TerminalCapabilities

Build the final capability set.

pub const fn true_color(self, enabled: bool) -> Self

Set true color (24-bit RGB) support.

pub const fn colors_256(self, enabled: bool) -> Self

Set 256-color palette support.

pub const fn sync_output(self, enabled: bool) -> Self

Set synchronized output (DEC mode 2026) support.

pub const fn osc8_hyperlinks(self, enabled: bool) -> Self

Set OSC 8 hyperlinks support.

pub const fn scroll_region(self, enabled: bool) -> Self

Set scroll region (DECSTBM) support.

pub const fn in_tmux(self, enabled: bool) -> Self

Set whether running inside tmux.

pub const fn in_screen(self, enabled: bool) -> Self

Set whether running inside GNU screen.

pub const fn in_zellij(self, enabled: bool) -> Self

Set whether running inside Zellij.

pub const fn in_wezterm_mux(self, enabled: bool) -> Self

Set whether running inside a WezTerm mux-served session.

pub const fn kitty_keyboard(self, enabled: bool) -> Self

Set Kitty keyboard protocol support.

pub const fn focus_events(self, enabled: bool) -> Self

Set focus event reporting support.

pub const fn bracketed_paste(self, enabled: bool) -> Self

Set bracketed paste mode support.

pub const fn mouse_sgr(self, enabled: bool) -> Self

Set SGR mouse protocol support.

pub const fn osc52_clipboard(self, enabled: bool) -> Self

Set OSC 52 clipboard support.

Trait Implementations

impl Clone for CapabilityProfileBuilder

fn clone(&self) -> CapabilityProfileBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CapabilityProfileBuilder

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

Formats the value using the given formatter.

impl Default for CapabilityProfileBuilder

fn default() -> Self

Returns the “default value” for a type.