Enum OptimizedEvent 

pub enum OptimizedEvent<M> {
    Key(KeyEvent),
    Mouse(MouseEvent),
    Resize {
        width: u16,
        height: u16,
    },
    Tick,
    User(InlineMessage<M>),
    Quit,
    Focus,
    Blur,
    Suspend,
    Resume,
    Paste(Cow<'static, str>),
    // some variants omitted
}

Zero-cost event wrapper with inline storage for small messages

Variants

Key(KeyEvent)

A keyboard event - stored inline, no allocation

Mouse(MouseEvent)

A mouse event - stored inline, no allocation

Resize

Terminal was resized - stored inline, no allocation

Fields

width: u16

Terminal width in columns

height: u16

Terminal height in rows

Tick

A tick event - stored inline, no allocation

User(InlineMessage<M>)

User-defined message with inline storage optimization

Quit

Request to quit the program - stored inline, no allocation

Focus

Terminal gained focus - stored inline, no allocation

Blur

Terminal lost focus - stored inline, no allocation

Suspend

Program suspend request (Ctrl+Z) - stored inline, no allocation

Resume

Program resumed from suspend - stored inline, no allocation

Paste(Cow<'static, str>)

Bracketed paste event with COW string for efficiency

Implementations

impl<M> OptimizedEvent<M>

pub fn user(msg: M) -> Self

Create a new user event with automatic storage optimization

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

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 const fn is_user(&self) -> bool

Check if this is a user message

pub 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 const fn is_resize(&self) -> bool

Check if this is a resize event

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

Get resize dimensions if this is a resize event

Trait Implementations

impl<M: Clone> Clone for OptimizedEvent<M>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<M: Debug> Debug for OptimizedEvent<M>

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

Formats the value using the given formatter.

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

Convert from the standard Event to OptimizedEvent

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

Converts to this type from the input type.

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

Convert from OptimizedEvent back to standard Event

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

Converts to this type from the input type.