Struct TerminalSession 

pub struct TerminalSession { /* private fields */ }

Complete RAII ownership of a terminal session, in either ScreenMode.

Construction enables raw mode and enhanced keyboard reporting, hides the cursor, and — depending on the mode — enters the alternate screen and enables mouse capture. Enhanced reporting is what lets crossterm distinguish chords such as Shift+Enter from plain Enter on ANSI terminals; Windows console events already carry modifier state through the native input API. Drop restores exactly what it took, including when unwinding from a panic. Pre-existing raw mode and keyboard-reporting stack entries are preserved. If construction fails partway through, it performs the same best-effort rollback before returning.

A split-footer session touches neither the alternate screen nor (by default) mouse capture, so the terminal’s scrollback, selection, and wheel keep working while the footer is up. It does not reserve or release the footer’s rows — that is the renderer’s job, since only it knows where the viewport landed: see pin_footer and close_footer.

Implementations

impl TerminalSession

pub fn enter() -> Result<Self>

Enter a full-screen session on the alternate screen, rolling back on failure. Shorthand for enter_with(ScreenMode::Alternate).

pub fn enter_with(mode: ScreenMode) -> Result<Self>

Enter a session in mode, rolling back on failure.

pub fn mode(&self) -> ScreenMode

The mode this session was entered in.

pub fn leave(&mut self)

Restore the terminal immediately. Calling this more than once is safe.

Trait Implementations

impl Drop for TerminalSession

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.