Struct RichTerminal 

pub struct RichTerminal { /* private fields */ }

A raw-mode Terminal that reads individual keys and redraws frames.

Render output is written to stderr, matching the stream prompts style against.

Implementations

impl RichTerminal

pub fn stderr() -> AppResult<Self>

Build a rich terminal rendering to stderr.

Errors

Returns an error unless both stderr and stdin are terminals: frames are drawn to stderr, while raw-mode key input is read from stdin, so both streams must be a real TTY.

Trait Implementations

impl Drop for RichTerminal

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.

impl Terminal for RichTerminal

fn capabilities(&self) -> Capabilities

The interaction model this terminal supports.

fn read_line(&mut self) -> AppResult<Option<String>>

Read one whole line (line-driven terminals).

fn read_key(&mut self) -> AppResult<Key>

Read one decoded keystroke (key-driven terminals).

fn write(&mut self, text: &str) -> AppResult<()>

Write text verbatim (no trailing newline).

fn write_line(&mut self, text: &str) -> AppResult<()>

Write text followed by a newline (a carriage return + line feed in raw mode).

fn flush(&mut self) -> AppResult<()>

Flush any buffered output.

fn clear_last_lines(&mut self, count: u16) -> AppResult<()>

Move the cursor up count lines and clear from there down, so the next frame overwrites the previous one. A no-op for line-driven terminals.

fn begin_interactive(&mut self) -> AppResult<()>

Enter interactive (raw) mode before a key-driven loop. A no-op for line-driven terminals.

fn end_interactive(&mut self) -> AppResult<()>

Leave interactive (raw) mode after a key-driven loop. A no-op for line-driven terminals.