Struct Modes 

pub struct Modes {
    pub dec: DecModes,
    pub ansi: AnsiModes,
}

Combined mode state for the terminal.

Fields

dec: DecModes

ansi: AnsiModes

Implementations

impl Modes

pub fn new() -> Self

Construct default modes (typical xterm defaults). DECAWM and DECTCEM are ON by default.

pub fn reset(&mut self)

Reset all modes to power-on defaults.

pub fn dec_flags(&self) -> DecModes

Raw access to DEC mode flags.

pub fn origin_mode(&self) -> bool

Whether origin mode (DECOM) is enabled.

pub fn set_origin_mode(&mut self, enabled: bool)

Enable/disable origin mode.

pub fn autowrap(&self) -> bool

Whether autowrap (DECAWM) is enabled.

pub fn set_autowrap(&mut self, enabled: bool)

Enable/disable autowrap.

pub fn cursor_visible(&self) -> bool

Whether the cursor is visible (DECTCEM).

pub fn set_cursor_visible(&mut self, enabled: bool)

Enable/disable cursor visibility.

pub fn insert_mode(&self) -> bool

Whether insert mode (IRM) is enabled.

pub fn set_insert_mode(&mut self, enabled: bool)

Enable/disable insert mode.

pub fn alt_screen(&self) -> bool

Whether alt screen buffer is active.

pub fn set_alt_screen(&mut self, enabled: bool)

Enable/disable alt screen.

pub fn bracketed_paste(&self) -> bool

Whether bracketed paste is enabled.

pub fn set_bracketed_paste(&mut self, enabled: bool)

Enable/disable bracketed paste.

pub fn focus_events(&self) -> bool

Whether focus event reporting is enabled.

pub fn set_focus_events(&mut self, enabled: bool)

Enable/disable focus events.

pub fn sync_output(&self) -> bool

Whether synchronized output is enabled.

pub fn set_sync_output(&mut self, enabled: bool)

Enable/disable synchronized output.

pub fn set_dec_mode(&mut self, mode: u16, enabled: bool) -> bool

Set a DEC private mode by its ECMA-48 number. Returns true if the mode is recognized.

pub fn dec_mode(&self, mode: u16) -> Option<bool>

Query a DEC private mode by number.

Returns:

• Some(true) if the mode is recognized and set,
• Some(false) if the mode is recognized and reset,
• None if the mode number is unknown.

pub fn set_ansi_mode(&mut self, mode: u16, enabled: bool) -> bool

Set an ANSI standard mode by its number. Returns true if the mode is recognized.

Trait Implementations

impl Clone for Modes

fn clone(&self) -> Modes

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Modes

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

Formats the value using the given formatter.

impl Default for Modes

fn default() -> Modes

Returns the “default value” for a type.

impl PartialEq for Modes

fn eq(&self, other: &Modes) -> 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 Copy for Modes

impl Eq for Modes

impl StructuralPartialEq for Modes