Struct TermInputParser 

pub struct TermInputParser { /* private fields */ }

Available on crate features event and term only.

🮖 🎫 ::= Parses terminal input bytes into normalized events.

---

^{📍 sys/os/term}

^{📦 size_of::<TermInputParser>() == 19 bytes / 152 bits}

---

TermInputParser is a byte-fed state machine. It accepts ordinary bytes, UTF-8 text, and terminal escape sequences, returning an EventKind when a complete input event has been recognized.

It is intentionally independent from any concrete terminal backend. Linux, Windows, web-terminal, pseudo-terminal, and test backends can all feed bytes into the same parser.

Public output

The public feed method returns only normalized user-facing events.

Terminal replies used for probing capabilities are parsed internally and are exposed only inside the crate.

Escape handling

A lone ESC byte is ambiguous: it may be the Escape key, or it may begin a longer escape sequence. Backends should call flush_escape after their escape timeout expires.

Supported seed grammar

The first parser layer recognizes:

• printable ASCII
• UTF-8 scalar values
• Enter, Tab, Backspace, Escape
• basic Control-letter combinations
• common CSI navigation and editing keys
• cursor-position and device-attribute replies, internally

Terminal limits

Terminal input is normalized from the byte stream reported by the active terminal emulator. Some information may be unavailable because terminals often reserve key or mouse combinations for selection, menus, shortcuts, or scrollback behavior before the application receives them.

In SGR mouse mode, terminal reports can encode Shift, Alt/Meta, and Control modifier bits. TermInputParser preserves those bits when present, but applications should not assume every terminal will report every modifier combination. In particular, Shift-click and Control-click are commonly intercepted or repurposed by terminal emulators.

Implementations

impl TermInputParser

pub const fn new() -> Self

Returns a new parser in the ground state.

pub fn feed(&mut self, byte: u8) -> Option<EventKind>

Feeds one byte into the parser.

Returns Some(EventKind) when the byte completes a user-facing event.

Returns None while a multi-byte sequence is still pending, or when the completed sequence is an internal terminal reply.

Use flush_escape to resolve a pending lone ESC after the backend’s escape timeout expires.

pub const fn flush_escape(&mut self) -> Option<EventKind>

Flushes a pending lone ESC as an Escape key press.

Returns None unless the parser is currently waiting after an ESC byte.

This is needed because terminal escape sequences and the Escape key share the same leading byte.

Trait Implementations

impl Clone for TermInputParser

fn clone(&self) -> TermInputParser

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl ConstInit for TermInputParser

const INIT: Self

Returns the compile-time “initial value” for a type.

impl Debug for TermInputParser

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

Formats the value using the given formatter.

impl Default for TermInputParser

fn default() -> TermInputParser

Returns the “default value” for a type.