Struct Parser 

pub struct Parser { /* private fields */ }

An incremental parser for terminal input.

Feed it bytes as they arrive with Parser::feed, then pull events out with Parser::next_event. A sequence split across two reads is handled: the parser waits for the rest. Unknown or malformed sequences are skipped and never panic or block later input.

Implementations

impl Parser

pub fn new() -> Parser

Creates an empty parser.

pub fn feed(&mut self, bytes: &[u8])

Adds input bytes to the parser.

pub fn next_event(&mut self) -> Option<Event>

The next complete event, or None if more bytes are needed.

pub fn expect_cursor_position(&mut self)

Tells the parser that a cursor position report (ESC [ row ; col R) is on its way, in answer to a ESC [ 6 n query. The next such sequence is then kept for Parser::take_cursor_position instead of being read as a key, because it is otherwise indistinguishable from Ctrl+F3.

pub fn take_cursor_position(&mut self) -> Option<(u32, u32)>

The (row, column) of the last cursor position report, counted from 1, or None if none has arrived since this was last called.

pub fn has_pending(&self) -> bool

Whether bytes are waiting for the rest of an escape sequence. After Parser::next_event returns None, this is true if more input could still complete an event, so the caller should wait a moment and then call Parser::flush.

pub fn flush(&mut self) -> Option<Event>

Call when no more bytes are coming for a moment (for example after a short read timeout). A lone Escape byte could be the Escape key or the start of a longer sequence; this settles it as the Escape key.

Trait Implementations

impl Debug for Parser

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

Formats the value using the given formatter.

impl Default for Parser

fn default() -> Self

Returns the “default value” for a type.