Enum EzEvent 

pub enum EzEvent<CID, CM>
where
    CID: EzCptIds,
    CM: EzMsg,
{
    Keyboard(KeyEvent),
    Mouse(MouseEvent),
    WindowResize(u16, u16),
    ForceFocus(EzCptId<CID>),
    ForceBlur(),
    FocusGained,
    FocusLost,
    Paste(String),
    Init,
    Tick,
    Render,
    Quit,
    None,
    Error(Error),
    UpdateLegend(String, Vec<Matcher>),
    Client(CM),
}

All the events that can be sent across the application. Your custom events will be wrapped inside EzEvent::Client.

Variants

Keyboard(KeyEvent)

A keyboard event from crossterm

Mouse(MouseEvent)

A mouse event from crossterm

WindowResize(u16, u16)

A window resize event from crossterm

ForceFocus(EzCptId<CID>)

Force the focus to a given component ID.

ForceBlur()

Force the blur of the current focused component.

FocusGained

A focus gained event from crossterm. This is unrelated to the focus in-app; it means the terminal holding your app received focus from your window manager.

FocusLost

A focus lost event from crossterm. This is unrelated to the focus in-app; it means the terminal holding your app received focus from your window manager.

Paste(String)

A paste event from crossterm

Init

The event send after app is started

Tick

The event send on each tick (not used by the lib)

Render

The event send to trigger a render

Quit

The vent sent to order the app to gracefully exit

None

An empty event to be returned when no event is emited, but we want to prevent the default app event handling (focus/quit)

Error(Error)

Sent when an unexpected error occurs

UpdateLegend(String, Vec<Matcher>)

Set the dynamic legend

Client(CM)

Wraps any events related to your business logic.

Implementations

impl<CID, CM> EzEvent<CID, CM>

where CID: EzCptIds, CM: EzMsg,

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

Map this event to Some if possible; None otherwise.

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

Map this event to Some if possible; None otherwise.

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

Map this event to Some([(&u16, &u16)]) if it’s a EzEvent::WindowResize; None otherwise.

pub fn as_client(&self) -> Option<&CM>

Map this event to your business logic event if possible; None otherwise.

impl<CID, CM> EzEvent<CID, CM>

where CID: EzCptIds, CM: EzMsg,

pub fn try_original(&self) -> Option<CrosstermEvent>

Try to convert this event to a crossterm event.

Trait Implementations

impl<CID, CM> Clone for EzEvent<CID, CM>

where CID: EzCptIds + Clone, CM: EzMsg + Clone,

fn clone(&self) -> EzEvent<CID, CM>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<CID, CM> Debug for EzEvent<CID, CM>

where CID: EzCptIds + Debug, CM: EzMsg + Debug,

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

Formats the value using the given formatter.

impl<CID, CM> Eq for EzEvent<CID, CM>

where CID: EzCptIds + Eq, CM: EzMsg + Eq,

impl<CID, CM> From<Event> for EzEvent<CID, CM>

where CID: EzCptIds, CM: EzMsg,

Convert a crossterm event to a Event. Only the key events are not a one to one conversion; we have to differentiate between key press, key repeat, and key release.

fn from(event: CrosstermEvent) -> Self

Converts to this type from the input type.

impl<CID, CM> PartialEq for EzEvent<CID, CM>

where CID: EzCptIds + PartialEq, CM: EzMsg + PartialEq,

fn eq(&self, other: &EzEvent<CID, CM>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<CID, CM> StructuralPartialEq for EzEvent<CID, CM>

where CID: EzCptIds + PartialEq, CM: EzMsg + PartialEq,