Struct SuspendGuard 

pub struct SuspendGuard<'a, W: Write> { /* private fields */ }

RAII guard returned by Crossterm::suspend; see that method’s docs for the full contract.

Borrows the suspended Crossterm mutably for its whole lifetime, so no other method on it can be called (accidentally drawing, polling, or moving the cursor) while the real terminal is handed back to the OS/shell.

Implementations

impl<W: Write> SuspendGuard<'_, W>

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

Restores every option the suspended Crossterm was originally built with and forces a full redraw on the next [Output::draw]. Equivalent to letting the guard drop, but lets a caller observe the std::io::Error a dropped guard would otherwise discard.

Errors

Returns an std::io::Error if any of the terminal-restoring commands fail (e.g. a closed terminal or disconnected pipe).

Trait Implementations

impl<W: Write> Drop for SuspendGuard<'_, W>

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.