Struct unsegen::input::Input

pub struct Input {
    pub event: Event,
    pub raw: Vec<u8>,
}

A structure corresponding to a single input event, e.g., a single keystroke or mouse event.

In addition to the semantic Event enum itself, the raw bytes that created this event are available, as well. This is useful if the user wants to pass the input on to some other terminal-like abstraction under certain circumstances (e.g., when writing a terminal multiplexer).

Fields

event: Event

raw: Vec<u8>

Implementations

impl Input

pub fn read_all<R: Read>(read: R) -> InputIter<R>

Create an iterator that reads from the provided argument and converts the read bytes into a stream of Inputs.

Please note that the iterator blocks when no bytes are available from the Read source.

pub fn chain<B: Behavior>(self, behavior: B) -> InputChain

Begin matching and processing of the event. See InputChain.

pub fn matches<T: ToEvent>(&self, e: T) -> bool

Check whether this event is equal to the provided event-like argument.

Trait Implementations

impl Clone for Input

fn clone(&self) -> Input

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Input

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

Formats the value using the given formatter.

impl From<Input> for InputChain

fn from(input: Input) -> Self

Performs the conversion.

impl PartialEq<Input> for Input

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Eq for Input

impl StructuralEq for Input

impl StructuralPartialEq for Input