Struct Tui 

pub struct Tui { /* private fields */ }

An owned terminal in raw mode + alternate screen, restored on drop.

Implementations

impl Tui

pub fn enter(mouse: bool) -> Result<Tui>

Enters raw mode and the alternate screen (with mouse capture if enabled).

Errors (without touching the terminal) when stderr is not a real terminal. The TUI draws to stderr, and enable_raw_mode performs a tcsetattr on the controlling terminal — so taking it over is only safe when stderr is genuinely a terminal. Enforcing that precondition here, at the irreversible boundary, rather than relying solely on the higher-level crate::cx::Cx TTY gate, keeps any non-TTY run (tests, pipes, or a cargo mutants child in a background process group) from being stopped by SIGTTOU and wedging indefinitely.

pub fn draw(&mut self, app: &App) -> Result<()>

Draws the current app state.

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

Leaves raw mode / alt screen to run a foreground program (e.g. editor).

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

Re-enters raw mode / alt screen after Tui::suspend.

pub fn size(&self) -> (u16, u16)

The current terminal size (cols, rows).

Trait Implementations

impl Drop for Tui

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.