Skip to main content

Capabilities

Struct Capabilities 

Source
pub struct Capabilities {
Show 13 fields pub synchronized_output: bool, pub grapheme_clusters: bool, pub in_band_resize: bool, pub mouse_normal: bool, pub mouse_button: bool, pub mouse_any: bool, pub mouse_sgr: bool, pub mouse_sgr_pixel: bool, pub sixel: bool, pub clipboard: bool, pub kitty_keyboard: bool, pub modify_other_keys: bool, pub true_color: bool,
}
Expand description

Terminal capabilities detected from the replies to the queries Screen::init fires. Every field answers a single question: does the terminal support this? The facade intercepts the reply events as they flow through read_event / try_read_event, records support here, and applies the render-affecting ones — the app never sees the reply events. Read back with Screen::capabilities.

Fields§

§synchronized_output: bool

Synchronized output (DEC private mode 2026). Applied: frames are wrapped in begin/end-synchronized-update markers.

§grapheme_clusters: bool

Unicode core / grapheme-cluster mode (DEC private mode 2027). Applied: cell widths are measured per grapheme cluster.

§in_band_resize: bool

In-band resize notifications (DEC private mode 2048).

§mouse_normal: bool

Normal mouse button tracking (DEC private mode 1000).

§mouse_button: bool

Button-event mouse tracking (DEC private mode 1002).

§mouse_any: bool

Any-event mouse tracking (DEC private mode 1003).

§mouse_sgr: bool

SGR mouse encoding (DEC private mode 1006).

§mouse_sgr_pixel: bool

SGR-pixel mouse encoding (DEC private mode 1016).

§sixel: bool

Sixel graphics (Primary DA attribute 4).

§clipboard: bool

Clipboard access (Primary DA attribute 52).

§kitty_keyboard: bool

Kitty keyboard protocol (the terminal answered CSI ? u).

§modify_other_keys: bool

xterm modifyOtherKeys (the terminal answered CSI ? 4 m).

§true_color: bool

Direct (24-bit) color, confirmed by an XTGETTCAP RGB/Tc reply. Applied: the renderer’s color profile is upgraded to Profile::TrueColor.

Trait Implementations§

Source§

impl Clone for Capabilities

Source§

fn clone(&self) -> Capabilities

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Capabilities

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Capabilities

Source§

fn default() -> Capabilities

Returns the “default value” for a type. Read more
Source§

impl PartialEq for Capabilities

Source§

fn eq(&self, other: &Capabilities) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for Capabilities

Source§

impl Eq for Capabilities

Source§

impl StructuralPartialEq for Capabilities

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> ErasedDestructor for T
where T: 'static,