Enum Event 

pub enum Event {
    Key(KeyEvent),
    Mouse(MouseEvent),
    Resize {
        width: u16,
        height: u16,
    },
    Paste(PasteEvent),
    Ime(ImeEvent),
    Focus(bool),
    Clipboard(ClipboardEvent),
    Tick,
}

Canonical input event.

This enum represents all possible input events that ftui can receive from the terminal.

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.

Paste(PasteEvent)

Paste event (from bracketed paste mode).

Ime(ImeEvent)

IME composition event (preedit lifecycle).

Focus(bool)

Focus gained or lost.

true = focus gained, false = focus lost.

Clipboard(ClipboardEvent)

Clipboard content received (optional, from OSC 52 response).

Tick

A tick event from the runtime.

Fired when a scheduled tick interval elapses. Applications use this for periodic updates (animations, polling, timers). The model’s update method receives the tick and can respond with state changes.

Implementations

impl Event

pub fn from_crossterm(event: Event) -> Option<Event>

Convert a Crossterm event into an ftui Event.

pub const fn event_type_label(&self) -> &'static str

Return a static label for the event type (for metrics/tracing).

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<(), Error>

Formats the value using the given formatter.

impl From<Event> for CassMsg

fn from(event: Event) -> Self

Converts to this type from the input type.

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