Struct TerminalGuard 

pub struct TerminalGuard { /* private fields */ }

RAII guard that enters raw mode + the alternate screen on construction and restores the original terminal state on drop.

Implementations

impl TerminalGuard

pub fn terminal_mut(&mut self) -> &mut Tui

impl TerminalGuard

pub fn new() -> Result<Self>

Enters raw mode and the alternate screen, and captures the mouse so Muster owns pane-scoped selection and scrolling.

Errors

Returns an error if raw mode cannot be enabled, the alternate screen cannot be entered, or the terminal backend fails to initialize.

pub fn copy_to_clipboard(&mut self, text: &str) -> Result<()>

Copies text onto the system clipboard: a native clipboard tool when one works (herdr’s preference), falling back to OSC 52 through the host terminal.

Errors

Returns an error when the escape sequence cannot be written to stdout.

pub fn set_pointer_shape(&mut self, shape: PointerShape) -> Result<()>

Asks the host terminal to show shape as the mouse pointer (OSC 22).

Errors

Returns an error when the escape sequence cannot be written to stdout.

pub fn restore() -> Result<()>

Restores the terminal to its original cooked state. Safe to call more than once; used by both Drop and the panic hook.

Errors

Returns an error if raw mode cannot be disabled or the alternate screen cannot be left.

Trait Implementations

impl Drop for TerminalGuard

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.