Struct Term 

pub struct Term {
    pending: Vec<u8>,
    out: BufWriter<Stdout>,
}

Fields

pending: Vec<u8>

Bytes read from stdin but not yet consumed as a key.

One read can return a whole escape sequence, several keystrokes from a fast typist, or half of either. Without this, the tail of a burst is silently dropped.

out: BufWriter<Stdout>

Implementations

impl Term

pub fn enter() -> Result<Term>

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

Visible size, re-read every frame.

The SIGWINCH handler enter installs records nothing; it exists only to interrupt the poll the draw loop is parked in. This call is what learns the new size, on the frame that interruption paints.

pub fn draw(&mut self, rows: &[String]) -> Result<()>

Paint one frame: home the cursor, write every row, erase whatever the last frame left below.

A full repaint rather than a diff. At 200×60 that is 12 000 cells, and one write of 30 KB costs less than tracking which of them changed.

pub fn key(&mut self, timeout_ms: i32) -> Result<Option<Key>>

Next key, or None if timeout_ms passed with nothing to read.

Trait Implementations

impl Drop for Term

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.