Struct TerminalSession 

pub struct TerminalSession<'a, C: RawModeControl + CommandWriter + KeyboardEnhancementQuery + ?Sized> { /* private fields */ }

A guard for every terminal state successfully acquired during entry.

Call restore on normal and error returns so restoration errors can be reported. Drop is the final guard during panic unwinding. It cannot report restoration failures. The session cannot restore the cursor’s pre-entry position, process aborts, kill -9, or signals whose handling never unwinds through this value.

Implementations

impl<'a, C> TerminalSession<'a, C>

where C: RawModeControl + CommandWriter + KeyboardEnhancementQuery + ?Sized,

pub fn enter( control: &'a mut C, options: SessionOptions, ) -> Result<Self, SessionError>

Acquires the requested modes, restoring partial state if entry fails.

pub fn control_mut(&mut self) -> &mut C

Borrows the underlying control while the session remains active.

pub fn restore(&mut self) -> Result<()>

Attempts every outstanding restoration in reverse acquisition order.

The first error is returned after all remaining steps and the final flush have been attempted. Repeated calls are no-ops.

Trait Implementations

impl<C> Drop for TerminalSession<'_, C>

where C: RawModeControl + CommandWriter + KeyboardEnhancementQuery + ?Sized,

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.