Skip to main content

TerminalGuard

Struct TerminalGuard 

Source
pub struct TerminalGuard<B: Backend + Write> {
    pub(crate) terminal: Terminal<B>,
    pub(crate) hook: Option<Arc<Box<dyn Fn(&PanicHookInfo<'_>) + Sync + Send + 'static>>>,
}
Expand description

Handles terminal setup and teardown for interactive TUIs.

Fields§

§terminal: Terminal<B>§hook: Option<Arc<Box<dyn Fn(&PanicHookInfo<'_>) + Sync + Send + 'static>>>

Implementations§

Source§

impl<B: Backend + Write> TerminalGuard<B>

Source

pub fn with<T>(terminal: Terminal<B>, f: impl FnMut(&mut Terminal<B>) -> T) -> T

Runs a closure while the terminal is in alternate-screen raw mode.

Source

pub(crate) fn setup(&mut self)

Source

pub(crate) fn restore(&mut self)

Source

pub(crate) fn half_restore(w: &mut impl Write)

Trait Implementations§

Source§

impl<B: Backend + Write> Drop for TerminalGuard<B>

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

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. Read more

Auto Trait Implementations§

§

impl<B> Freeze for TerminalGuard<B>
where B: Freeze,

§

impl<B> !RefUnwindSafe for TerminalGuard<B>

§

impl<B> Send for TerminalGuard<B>
where B: Send,

§

impl<B> Sync for TerminalGuard<B>
where B: Sync,

§

impl<B> Unpin for TerminalGuard<B>
where B: Unpin,

§

impl<B> UnsafeUnpin for TerminalGuard<B>
where B: UnsafeUnpin,

§

impl<B> !UnwindSafe for TerminalGuard<B>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

Layout§

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.