Enum Event 

pub enum Event {
    Key(Key),
    KeyUp(Key),
    Mouse(Mouse),
    Resize {
        columns: u16,
        rows: u16,
    },
    Paste(String),
    Tick,
    Returned(Option<i32>),
    Link(String),
}

One input event.

Variants

Key(Key)

A key pressed, or held down long enough to repeat.

KeyUp(Key)

A key let go. Terminals report it with the kitty keyboard protocol on (see SessionOptions::legacy_keys), and the Windows console always. Nothing binds it: a component that wants it matches it itself.

Mouse(Mouse)

Resize

The terminal is now this size.

Fields

columns: u16

rows: u16

Paste(String)

Text pasted with bracketed paste on.

Tick

A component’s tick interval passed (see Component::tick).

Returned(Option<i32>)

A command the component handed the terminal to (with Flow::Handoff) exited with this code (None: killed by a signal).

Link(String)

The left button went down on a hyperlink (an OSC 8 region: a Style with a link) in the component’s view (#476). Delivered instead of the Event::Mouse; what to do with the URL (open it, print it, ignore it) is the component’s or its caller’s choice, never the event loop’s.

Implementations

impl Event

pub fn key(&self) -> Option<Key>

The key, when this is a key press.

impl Event

pub fn mouse(&self) -> Option<Mouse>

The mouse event, when this is one.

Trait Implementations

impl Clone for Event

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 Event

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

Formats the value using the given formatter.

impl Eq for Event

impl From<Key> for Event

fn from(key: Key) -> Event

Converts to this type from the input type.

impl PartialEq for Event

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Event