Struct termwiz::caps::Capabilities

pub struct Capabilities { /* private fields */ }

Capabilities holds information about the capabilities of a terminal. On POSIX systems this is largely derived from an available terminfo database, but there are some newish capabilities that are not yet described by the majority of terminfo installations and thus have some additional handling in this struct.

Implementations

impl Capabilities

pub fn new_from_env() -> Result<Self>

Detect the capabilities of the terminal and return the Capability object holding the outcome. This function inspects the environment variables to build up configuration hints.

pub fn new_with_hints(hints: ProbeHints) -> Result<Self>

Build a Capabilities object based on the provided ProbeHints object.

pub fn color_level(&self) -> ColorLevel

Indicates how many colors are supported

pub fn sixel(&self) -> bool

Does the terminal support SIXEL graphics?

pub fn hyperlinks(&self) -> bool

Does the terminal support hyperlinks? See https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda

pub fn iterm2_image(&self) -> bool

Does the terminal support the iTerm2 image protocol? See https://www.iterm2.com/documentation-images.html

pub fn bce(&self) -> bool

Is bce, background color erase supported? http://invisible-island.net/ncurses/ncurses-slang.html#env_COLORTERM_BCE

pub fn terminfo_db(&self) -> Option<&Database>

Returns a reference to the loaded terminfo, if any.

pub fn bracketed_paste(&self) -> bool

Whether bracketed paste is supported

pub fn mouse_reporting(&self) -> bool

Whether mouse reporting is supported

Trait Implementations

impl Clone for Capabilities

fn clone(&self) -> Capabilities

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Capabilities

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

Formats the value using the given formatter.