Struct AlternateScreenSession 

pub struct AlternateScreenSession { /* private fields */ }

Owns terminal modes for one alternate-screen application session.

Cleanup is best-effort in Drop, so normal return, errors, and unwinding all restore the shell-facing terminal state through the same owner.

Implementations

impl AlternateScreenSession

pub fn enter(mouse_capture: bool) -> Result<Self>

Enter raw mode and the alternate screen.

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

Temporarily restore the shell terminal for an external interactive app.

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

Re-enter the owned alternate-screen terminal after suspension.

Trait Implementations

impl Debug for AlternateScreenSession

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

Formats the value using the given formatter.

impl Drop for AlternateScreenSession

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.