Enum Event 

pub enum Event<CustomEvent: CustomEvent> {
    Key(KeyEvent),
    Standard(StandardEvent),
    Mouse(MouseEvent),
    None,
    Resize(u16, u16),
    MetaEvent(CustomEvent),
}

An event, either from an input device, system change or action event.

Variants

Key(KeyEvent)

A keyboard event.

Standard(StandardEvent)

An action event.

Mouse(MouseEvent)

A mouse event.

None

An empty event.

Resize(u16, u16)

A terminal resize event.

MetaEvent(CustomEvent)

Custom application defined events

Trait Implementations

impl<CustomEvent: Clone + CustomEvent> Clone for Event<CustomEvent>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<CustomEvent: Debug + CustomEvent> Debug for Event<CustomEvent>

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

Formats the value using the given formatter.

impl<CustomEvent: CustomEvent> From<Event> for Event<CustomEvent>

fn from(event: Event) -> Self

Converts to this type from the input type.

impl<CustomEvent: CustomEvent> From<KeyCode> for Event<CustomEvent>

fn from(code: KeyCode) -> Self

Converts to this type from the input type.

impl<CustomEvent: CustomEvent> From<KeyEvent> for Event<CustomEvent>

fn from(key_event: KeyEvent) -> Self

Converts to this type from the input type.

impl<CustomEvent: CustomEvent> From<MouseEvent> for Event<CustomEvent>

fn from(mouse_event: MouseEvent) -> Self

Converts to this type from the input type.

impl<CustomEvent: CustomEvent> From<StandardEvent> for Event<CustomEvent>

fn from(event: StandardEvent) -> Self

Converts to this type from the input type.

impl<CustomEvent: CustomEvent> From<char> for Event<CustomEvent>

fn from(c: char) -> Self

Converts to this type from the input type.

impl<CustomEvent: PartialEq + CustomEvent> PartialEq for Event<CustomEvent>

fn eq(&self, other: &Event<CustomEvent>) -> 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<CustomEvent: PartialOrd + CustomEvent> PartialOrd for Event<CustomEvent>

fn partial_cmp(&self, other: &Event<CustomEvent>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<CustomEvent: Copy + CustomEvent> Copy for Event<CustomEvent>

impl<CustomEvent: Eq + CustomEvent> Eq for Event<CustomEvent>

impl<CustomEvent: CustomEvent> StructuralPartialEq for Event<CustomEvent>