Enum Event 

pub enum Event<M> {
    Key(KeyEvent),
    Mouse(MouseEvent),
    Resize {
        width: u16,
        height: u16,
    },
    Tick,
    User(M),
    Quit,
    Focus,
    Blur,
    Suspend,
    Resume,
    Paste(String),
    // some variants omitted
}

An event that can be received by the program

Variants

Key(KeyEvent)

A keyboard event

Mouse(MouseEvent)

A mouse event

Resize

Terminal was resized

Fields

width: u16

New terminal width in columns

height: u16

New terminal height in rows

Tick

A tick event (for animations, etc.)

User(M)

User-defined message

Quit

Request to quit the program

Focus

Terminal gained focus

Blur

Terminal lost focus

Suspend

Program suspend request (Ctrl+Z)

Resume

Program resumed from suspend

Paste(String)

Bracketed paste event

Implementations

impl<M> Event<M>

pub const fn is_key(&self) -> bool

Check if this is a key event

pub fn is_key_press(&self, key: Key) -> bool

Check if this is a specific key press

Example

if event.is_key_press(Key::Enter) {
    // Handle enter key
}

pub fn is_key_with_modifiers(&self, key: Key, modifiers: KeyModifiers) -> bool

Check if this is a specific key with modifiers

Example

if event.is_key_with_modifiers(Key::Char('c'), KeyModifiers::CONTROL) {
    // Handle Ctrl+C
}

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

Get the key event if this is a key event

pub const fn is_mouse(&self) -> bool

Check if this is a mouse event

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

Get the mouse event if this is a mouse event

pub fn is_click(&self) -> bool

Check if this is a mouse click at any position

pub fn as_click(&self) -> Option<(u16, u16)>

Get click position if this is a click event

Example

if let Some((x, y)) = event.as_click() {
    // Handle click at position (x, y)
}

pub fn is_resize(&self) -> bool

Check if this is a resize event

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

Get resize dimensions if this is a resize event

Example

if let Some((width, height)) = event.as_resize() {
    // Handle resize to width x height
}

pub const fn is_user(&self) -> bool

Check if this is a user message

pub const fn as_user(&self) -> Option<&M>

Get the user message if this is a user event

pub fn into_user(self) -> Option<M>

Take the user message if this is a user event

pub const fn is_quit(&self) -> bool

Check if this is a quit event

pub const fn is_tick(&self) -> bool

Check if this is a tick event

pub fn is_paste(&self) -> bool

Check if this is a paste event

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

Get pasted text if this is a paste event

pub fn is_focus(&self) -> bool

Check if this is a focus event

pub fn is_blur(&self) -> bool

Check if this is a blur event

pub fn is_suspend(&self) -> bool

Check if this is a suspend event

pub fn is_resume(&self) -> bool

Check if this is a resume event

Trait Implementations

impl<M> Clone for Event<M>

where M: Clone,

fn clone(&self) -> Event<M>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<M> Debug for Event<M>

where M: Debug,

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

Formats the value using the given formatter.

impl<M> From<OptimizedEvent<M>> for Event<M>

Convert from OptimizedEvent back to standard Event

fn from(event: OptimizedEvent<M>) -> Event<M>

Converts to this type from the input type.

impl<M> PartialEq for Event<M>

where M: PartialEq,

fn eq(&self, other: &Event<M>) -> 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<M> StructuralPartialEq for Event<M>