Enum Event 

#[non_exhaustive]
pub enum Event {
    Key(KeyEvent),
    Mouse(MouseEvent),
    Resize(u32, u32),
    Paste(String),
    FocusGained,
    FocusLost,
}

A terminal input event.

Produced each frame by the run loop and passed to your UI closure via crate::Context. Use the helper methods on Context (e.g., key(), key_code()) rather than matching on this type directly.

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.

Key(KeyEvent)

A keyboard event.

Mouse(MouseEvent)

A mouse event (requires mouse: true in crate::RunConfig).

Resize(u32, u32)

The terminal was resized to the given (columns, rows).

Paste(String)

Pasted text (bracketed paste). May contain newlines.

FocusGained

The terminal window gained focus.

FocusLost

The terminal window lost focus. Used to clear hover state.

Implementations

impl Event

pub fn key_char(c: char) -> Self

Create a key press event for a character.

pub fn key(code: KeyCode) -> Self

Create a key press event for a special key.

pub fn key_ctrl(c: char) -> Self

Create a key press event with Ctrl modifier.

pub fn key_mod(code: KeyCode, modifiers: KeyModifiers) -> Self

Create a key press event with custom modifiers.

pub fn resize(width: u32, height: u32) -> Self

Create a terminal resize event.

pub fn mouse_click(x: u32, y: u32) -> Self

Create a left mouse click event at (x, y).

pub fn mouse_move(x: u32, y: u32) -> Self

Create a mouse move event at the given position.

pub fn mouse_drag(x: u32, y: u32) -> Self

Create a left mouse drag event at (x, y).

pub fn mouse_up(x: u32, y: u32) -> Self

Create a left mouse button release event at (x, y).

pub fn scroll_up(x: u32, y: u32) -> Self

Create a scroll up event at the given position.

pub fn scroll_down(x: u32, y: u32) -> Self

Create a scroll down event at the given position.

pub fn key_release(c: char) -> Self

Create a key release event for a character.

pub fn paste(text: impl Into<String>) -> Self

Create a paste event with the given text.

pub fn as_key(&self) -> Option<&KeyEvent>

Returns the key event data if this is a Key variant.

pub fn as_mouse(&self) -> Option<&MouseEvent>

Returns the mouse event data if this is a Mouse variant.

pub fn as_resize(&self) -> Option<(u32, u32)>

Returns (columns, rows) if this is a Resize variant.

pub fn as_paste(&self) -> Option<&str>

Returns the pasted text if this is a Paste variant.

pub fn is_key(&self) -> bool

Returns true if this is a Key event.

pub fn is_mouse(&self) -> bool

Returns true if this is a Mouse event.

Trait Implementations

impl Clone for Event

fn clone(&self) -> Event

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 PartialEq for Event

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Event

impl StructuralPartialEq for Event