Struct TerminalGuard 

pub struct TerminalGuard { /* private fields */ }

An RAII guard that turns on terminal mouse capture (and optionally the keyboard-enhancement protocol) for as long as it is alive, and guarantees the terminal is put back the way it was — both on the normal exit path (via Drop) and on any panic (via a wrapped panic hook).

Create it after your terminal has been put into raw mode / the alternate screen (e.g. after ratatui::init()), and drop it before you tear that down (e.g. before ratatui::restore()):

use tui_panel_select::TerminalGuard;

let mut terminal = ratatui::init();
let guard = TerminalGuard::install(true)?;
let enhanced = guard.keyboard_enhancement_active();

// ... run your event loop, using `enhanced` to decide whether modifier
// combinations like Ctrl+Enter are reported distinctly ...

drop(guard); // restore mouse capture / keyboard flags
ratatui::restore();

Implementations

impl TerminalGuard

pub fn install(keyboard_enhancement: bool) -> Result<Self>

Enable mouse capture and install the panic-safe restore hook.

When keyboard_enhancement is true and the terminal advertises support, the keyboard-enhancement (disambiguate-escape-codes) protocol is pushed as well, so modifier combinations such as Ctrl+Enter are reported distinctly from a plain Enter. Use keyboard_enhancement_active to learn whether it actually took effect.

The current panic hook is taken and wrapped: on any panic the wrapper disables mouse capture (and pops the keyboard-enhancement flags, if they were pushed) before delegating to the previous hook.

pub fn keyboard_enhancement_active(&self) -> bool

Whether the keyboard-enhancement protocol was actually enabled (it is only enabled when requested and supported by the terminal).

Trait Implementations

impl Debug for TerminalGuard

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

Formats the value using the given formatter.

impl Drop for TerminalGuard

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.