Struct TerminalSession 

pub struct TerminalSession { /* private fields */ }

RAII guard for terminal raw mode, bracketed paste, and mouse capture.

Creating a TerminalSession enables raw mode (and optionally bracketed paste and mouse capture). When the session is dropped, all terminal state is restored automatically.

Usage

use tui::{TerminalSession, MouseCapture};

let _session = TerminalSession::new(
    true,               // enable bracketed paste
    MouseCapture::Enabled,
)?;
// Terminal is now in raw mode with paste and mouse capture.
// Dropping `_session` restores the terminal.

MouseCapture

• Disabled — No mouse events are reported.
• Enabled — Mouse clicks, scrolls, and drags are reported as events.

Related

• spawn_terminal_event_task() — Spawns a blocking tokio task that reads crossterm events and sends them over an mpsc::UnboundedReceiver<CrosstermEvent>. Pair this with a TerminalSession to build an event loop.
• terminal_size() — Returns the current terminal dimensions as (columns, rows).

Implementations

impl TerminalSession

pub fn new( enable_bracketed_paste: bool, mouse_capture: MouseCapture, ) -> Result<Self>

Trait Implementations

impl Drop for TerminalSession

fn drop(&mut self)

Executes the destructor for this type.