Enum Mode 

pub enum Mode {
    Ansi(u16),
    Dec(u16),
}

A terminal mode addressable by ANSI SM/RM or DECSET/DECRST.

Mode::Ansi writes ordinary CSI mode numbers such as ESC [ 4 h; Mode::Dec writes private mode numbers with ?, such as ESC [ ? 1049 h.

Variants

Ansi(u16)

Standard ANSI mode number.

Set/reset/request forms use ESC [ <number> h, ESC [ <number> l, and ESC [ <number> $ p.

Dec(u16)

DEC private mode number.

Set/reset/request forms use ESC [ ? <number> h, ESC [ ? <number> l, and ESC [ ? <number> $ p.

Implementations

impl Mode

pub const CURSOR_KEYS: Mode

DEC private mode 1 (DECCKM): cursor keys send application sequences when set and normal cursor sequences when reset.

pub const ANSI_VT52: Mode

DEC private mode 2 (DECANM): selects ANSI mode when set and VT52 mode when reset on terminals that implement it.

pub const COLUMN_132: Mode

DEC private mode 3 (DECCOLM): 132-column mode when set; commonly resets margins and clears display on supporting terminals.

pub const SMOOTH_SCROLL: Mode

DEC private mode 4 (DECSCLM): smooth scrolling when set, jump scrolling when reset.

pub const REVERSE_VIDEO: Mode

DEC private mode 5 (DECSCNM): reverse-video screen mode.

pub const ORIGIN: Mode

DEC private mode 6 (DECOM): absolute cursor positions are relative to the scroll region when set.

pub const AUTO_WRAP: Mode

DEC private mode 7 (DECAWM): automatically wrap at the right margin when set.

pub const AUTO_REPEAT: Mode

DEC private mode 8 (DECARM): key auto-repeat enabled when set.

pub const MOUSE_X10: Mode

DEC private mode 9: X10 mouse reporting.

pub const PRINT_FORM_FEED: Mode

DEC private mode 18 (DECPFF): print form-feed mode.

pub const PRINT_EXTENT: Mode

DEC private mode 19 (DECPEX): print extent mode.

pub const CURSOR_VISIBLE: Mode

DEC private mode 25 (DECTCEM): cursor visible when set, hidden when reset.

pub const NO_CLEAR_COLUMN: Mode

DEC private mode 40 (DECNCSM): allow column-mode changes without clearing on supporting terminals.

pub const NUMERIC_KEYPAD: Mode

DEC private mode 66 (DECNKM): keypad application/numeric behavior; see crate::ansi::keypad.

pub const BACKARROW_KEY: Mode

DEC private mode 67 (DECBKM): backarrow key sends backspace/delete according to set/reset state.

pub const LEFT_RIGHT_MARGIN: Mode

DEC private mode 69 (DECLRMM): enables left/right margin interpretation for DECSLRM.

pub const ALT_SCREEN_LEGACY: Mode

DEC private mode 47: legacy alternate screen buffer.

pub const MOUSE_NORMAL: Mode

DEC private mode 1000: report mouse button press/release events.

pub const MOUSE_HIGHLIGHT: Mode

DEC private mode 1001: highlight mouse tracking.

pub const MOUSE_BUTTON: Mode

DEC private mode 1002: report button-motion mouse events.

pub const MOUSE_ANY: Mode

DEC private mode 1003: report any-motion mouse events.

pub const FOCUS: Mode

DEC private mode 1004: enable focus in/out reports (ESC [ I / ESC [ O).

pub const MOUSE_UTF8: Mode

DEC private mode 1005: UTF-8 mouse coordinate encoding.

pub const MOUSE_SGR: Mode

DEC private mode 1006: SGR mouse coordinate encoding.

pub const MOUSE_URXVT: Mode

DEC private mode 1015: alternate mouse coordinate encoding.

pub const MOUSE_SGR_PIXEL: Mode

DEC private mode 1016: SGR-pixel mouse coordinate encoding.

pub const ALT_SCREEN: Mode

Alternate screen buffer (1047).

pub const SAVE_CURSOR: Mode

DEC private mode 1048: save/restore cursor around mode set/reset.

pub const ALT_SCREEN_SAVE_CURSOR: Mode

DEC private mode 1049: alternate screen buffer with cursor save/restore and clear semantics.

pub const BRACKETED_PASTE: Mode

DEC private mode 2004: wrap pasted data in bracketed-paste delimiters.

pub const SYNCHRONIZED_OUTPUT: Mode

DEC private mode 2026: synchronized output batching.

pub const UNICODE_CORE: Mode

DEC private mode 2027: Unicode core keyboard/input behavior on supporting terminals.

pub const LIGHT_DARK: Mode

DEC private mode 2031: light/dark color-scheme notifications.

pub const VISIBILITY_REPORTS: Mode

DEC private mode 2033: terminal visibility reports.

pub const IN_BAND_RESIZE: Mode

DEC private mode 2048: in-band resize reports.

pub const WIN32_INPUT: Mode

DEC private mode 9001: Win32-input reporting on supporting terminals.

impl Mode

pub const KEYBOARD_ACTION: Mode

ANSI mode 2 (KAM): keyboard action mode.

pub const INSERT: Mode

ANSI mode 4 (IRM): insert mode when set, replace mode when reset.

pub const BIDI_SUPPORT: Mode

ANSI mode 8 (BDSM): bidirectional-support mode.

pub const SEND_RECEIVE: Mode

ANSI mode 12 (SRM): send/receive mode, often associated with local echo behavior.

pub const LINE_FEED_NEW_LINE: Mode

ANSI mode 20 (LNM): line-feed/new-line handling mode.

impl Mode

pub fn set<W: Write>(self, w: &mut W) -> Result<()>

Write the set-mode sequence for this single mode.

This is a convenience wrapper around write_set_mode.

pub fn reset<W: Write>(self, w: &mut W) -> Result<()>

Write the reset-mode sequence for this single mode.

This is a convenience wrapper around write_reset_mode.

pub fn request<W: Write>(self, w: &mut W) -> Result<()>

Request this mode’s current state with DECRQM/RQM.

DEC modes emit ESC [ ? <mode> $ p; ANSI modes emit ESC [ <mode> $ p.

Trait Implementations

impl Clone for Mode

fn clone(&self) -> Mode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Mode

impl Debug for Mode

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

Formats the value using the given formatter.

impl Eq for Mode

impl Hash for Mode

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Mode

fn cmp(&self, other: &Mode) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Mode

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for Mode

fn partial_cmp(&self, other: &Mode) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for Mode