Struct Parser 

pub struct Parser { /* private fields */ }

An incremental parser for terminal input.

The parser keeps incomplete escape sequences in an internal buffer. Pass maybe_more = true when the current byte slice may end in the middle of a sequence. Completed events are queued until Self::pop removes them.

Examples

use termina::{Event, Parser};

let mut parser = Parser::default();
parser.parse(b"\x1b[5~", false);
assert!(matches!(parser.pop(), Some(Event::Key(_))));

Implementations

impl Parser

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

Removes and returns the oldest completed event.

pub fn parse(&mut self, bytes: &[u8], maybe_more: bool)

Adds bytes to the parser and queues any completed events.

Set maybe_more to true when the input source may provide more bytes for the same escape sequence later. Set it to false when the buffer should be treated as complete for now; malformed or incomplete sequences can then be discarded instead of held indefinitely.

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.