Struct SessionOptions 

pub struct SessionOptions {
    pub raw_mode: bool,
    pub alternate_screen: bool,
    pub bracketed_paste: bool,
    pub focus_change: bool,
    pub keyboard_enhancement: Option<KeyboardEnhancementFlags>,
    pub mouse_capture: bool,
    pub hide_cursor: bool,
}

Terminal modes acquired by a session.

The default acquires no modes. Prompt and TUI entry points choose their own explicit profiles rather than placing application policy in this crate.

Fields

raw_mode: bool

Enables raw input mode.

alternate_screen: bool

Uses the alternate screen buffer.

bracketed_paste: bool

Reports a paste as one paste event.

focus_change: bool

Reports terminal focus changes.

keyboard_enhancement: Option<KeyboardEnhancementFlags>

Requests the selected enhanced-keyboard information when supported.

mouse_capture: bool

Captures mouse input instead of leaving terminal text selection active.

hide_cursor: bool

Hides the cursor until a frame or restoration shows it.

Trait Implementations

impl Clone for SessionOptions

fn clone(&self) -> SessionOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SessionOptions

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

Formats the value using the given formatter.

impl Default for SessionOptions

fn default() -> SessionOptions

Returns the “default value” for a type.

impl PartialEq for SessionOptions

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

impl Eq for SessionOptions

impl StructuralPartialEq for SessionOptions