Enum pulldown_cmark_mdcat::terminal::TerminalProgram

pub enum TerminalProgram {
    Dumb,
    Ansi,
    ITerm2,
    Terminology,
    Kitty,
    WezTerm,
    VSCode,
}

A terminal application.

Variants

Dumb

A dumb terminal which does not support any formatting.

Ansi

A plain ANSI terminal which supports only standard ANSI formatting.

ITerm2

iTerm2.

iTerm2 is a powerful macOS terminal emulator with many formatting features, including images and inline links.

See https://www.iterm2.com for more information.

Terminology

Terminology.

See http://terminolo.gy for more information.

Kitty

Kitty.

kitty is a fast, featureful, GPU-based terminal emulator with a lot of extensions to the terminal protocol.

See https://sw.kovidgoyal.net/kitty/ for more information.

WezTerm

WezTerm

WezTerm is a GPU-accelerated cross-platform terminal emulator and multiplexer. It’s highly customizable and supports some terminal extensions.

See https://wezfurlong.org/wezterm/ for more information.

VSCode

The built-in terminal in VSCode.

Since version 1.80 it supports images with the iTerm2 protocol.

Implementations

impl TerminalProgram

pub fn detect() -> Self

Attempt to detect the terminal program mdcat is running on.

This function looks at various environment variables to identify the terminal program.

It first looks at $TERM to determine the terminal program, then at $TERM_PROGRAM, and finally at $TERMINOLOGY.

If $TERM is set to anything other than xterm-256colors it’s definitely accurate, since it points to the terminfo entry to use. $TERM also propagates across most boundaries (e.g. sudo, ssh), and thus the most reliable place to check.

However, $TERM only works if the terminal has a dedicated entry in terminfo database. Many terminal programs avoid this complexity (even WezTerm only sets $TERM if explicitly configured to do so), so mdcat proceeds to look at other variables. However, these are generally not as reliable as $TERM, because they often do not propagate across SSH or sudo, and may leak if one terminal program is started from another one.

Returns

• TerminalProgram::Kitty if $TERM is xterm-kitty.
• TerminalProgram::WezTerm if $TERM is wezterm.
• TerminalProgram::WezTerm if $TERM_PROGRAM is WezTerm.
• TerminalProgram::ITerm2 if $TERM_PROGRAM is iTerm.app.
• TerminalProgram::Terminology if $TERMINOLOGY is 1.
• TerminalProgram::Ansi otherwise.

pub fn capabilities(self) -> TerminalCapabilities

Get the capabilities of this terminal emulator.

Trait Implementations

impl Clone for TerminalProgram

fn clone(&self) -> TerminalProgram

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TerminalProgram

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

Formats the value using the given formatter.

impl Display for TerminalProgram

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

Formats the value using the given formatter.

impl PartialEq for TerminalProgram

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for TerminalProgram

impl Eq for TerminalProgram

impl StructuralPartialEq for TerminalProgram