Enum TerminalInput 

#[non_exhaustive]
pub enum TerminalInput {
    Text(String),
    Paste(String),
    Key(KeyInput),
    Mouse(MouseInput),
    Scroll(ScrollRequest),
    Focus(bool),
}

Everything the UI can send to the engine.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Text(String)

Raw text for the program, such as an IME commit.

Paste(String)

Pasted text, bracketed when the program asked for it.

Key(KeyInput)

A key.

Mouse(MouseInput)

A pointer event.

Scroll(ScrollRequest)

A viewport scroll.

Focus(bool)

Focus gained or lost.

Implementations

impl TerminalInput

pub fn is_interrupt(&self) -> bool

Whether this input interrupts the program (Ctrl+C), which jumps the queue and discards pending input.

pub fn budget(&self) -> usize

The bytes this input accounts for in the bounded queue.

Trait Implementations

impl Clone for TerminalInput

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TerminalInput

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

Formats the value using the given formatter.

impl PartialEq for TerminalInput

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for TerminalInput