Struct TerminalRawModeScope

pub struct TerminalRawModeScope { /* private fields */ }

Enable or disable the terminal raw mode while its instance is in scope.

While it automatically resets the mode when it’s out of scope, reset() should be called explicitly when the mode should be reset or at the end of the scope to avoid it being dropped earlier by the compiler.

Examples

use git_iblame::extensions::TerminalRawModeScope;

let mut terminal_raw_mode = TerminalRawModeScope::new(true)?;
// Do the work.
// If it returns early, the terminal raw mode will be reset automatically.
terminal_raw_mode.reset()?;

Implementations

impl TerminalRawModeScope

pub fn new(enable: bool) -> Result<Self>

Enable the raw mode if enable is true, or disable it if enable is false.

pub fn new_with_alternate_screen() -> Result<Self>

Switches to the alternate screen, in addition to the raw mode. See crossterm::terminal::EnterAlternateScreen.

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

Reset the terminal raw mode. This should be called when the mode should be reset, or at the end of the scope.

Even if the mode should be reset at the end of the scope, and that the Drop trait should reset the raw mode, it should be called to avoid it being dropped earlier by the compiler.

Trait Implementations

impl Debug for TerminalRawModeScope

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

Formats the value using the given formatter.

impl Drop for TerminalRawModeScope

fn drop(&mut self)

Calls reset() if it’s not already reset. This is called when the instance goes out of scope.