Struct SessionOptions 

pub struct SessionOptions {
    pub alternate_screen: bool,
    pub mouse: bool,
    pub bracketed_paste: bool,
    pub output: Output,
    pub legacy_keys: bool,
    pub backend: BackendKind,
    pub synchronized_output: Option<bool>,
    pub all_keys: bool,
}

What a session turns on.

Fields

alternate_screen: bool

Take over the whole screen, and give it back as it was on exit. Without it, components paint inline, below the cursor.

mouse: bool

Report mouse clicks and the wheel.

bracketed_paste: bool

Deliver pasted text as one Event::Paste.

output: Output

Where to paint.

legacy_keys: bool

Read keys as a legacy terminal sends them, even from a terminal with the kitty keyboard protocol. Without it, a terminal that answers the protocol’s query has it turned on: Ctrl+I and Tab are told apart (see Key::matches), and key releases arrive as Event::KeyUp (with crossterm; see BackendKind).

backend: BackendKind

The library that drives the terminal: crossterm unless this says otherwise.

synchronized_output: Option<bool>

Write each frame as one synchronized update (DEC private mode 2026): Some(true) always, Some(false) never. None, the default, leaves it to RICH_SYNC_OUTPUT (0 off, 1 on) and then to the terminal, which is asked in the kitty keyboard protocol’s start-up query. A session that asks nothing (legacy_keys, the termion backend, standard output not a terminal) leaves it off unless this or the environment turns it on.

all_keys: bool

With the kitty keyboard protocol, have every key reported as an escape code: releases then arrive for text keys too (letters, Space, Enter), and modifier keys pressed on their own arrive as KeyCode::Modifier, as a game wants them. Off by default: typed text then arrives as a base key and the modifiers held, which loses characters an input method composes. crossterm only (termwiz reads no releases); see Session::releases_reported.

Trait Implementations

impl Clone for SessionOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SessionOptions

impl Debug for SessionOptions

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

Formats the value using the given formatter.

impl Default for SessionOptions

fn default() -> Self

Returns the “default value” for a type.

impl Eq for SessionOptions

impl PartialEq for SessionOptions

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SessionOptions