Enum tuirealm::Event

pub enum Event<UserEvent>
where
    UserEvent: Eq + PartialEq + Clone + PartialOrd,
{
    Keyboard(KeyEvent),
    WindowResize(u16, u16),
    FocusGained,
    FocusLost,
    Paste(String),
    Tick,
    None,
    User(UserEvent),
}

An event raised by a user interaction

Variants

Keyboard(KeyEvent)

A keyboard event

WindowResize(u16, u16)

This event is raised after the terminal window is resized

FocusGained

Window focus gained

FocusLost

Window focus lost

Paste(String)

Clipboard content pasted

Tick

A ui tick event (should be configurable)

None

Unhandled event; Empty event

User(UserEvent)

User event; won’t be used by standard library or by default input event listener; but can be used in user defined ports

Trait Implementations

impl<UserEvent> Clone for Event<UserEvent>

where UserEvent: Eq + PartialEq + Clone + PartialOrd + Clone,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<UserEvent> Debug for Event<UserEvent>

where UserEvent: Eq + PartialEq + Clone + PartialOrd + Debug,

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

Formats the value using the given formatter.

impl<U> From<Event> for Event<U>

where U: Eq + PartialEq + Clone + PartialOrd + Send,

fn from(e: XtermEvent) -> Self

Converts to this type from the input type.

impl<UserEvent> PartialEq for Event<UserEvent>

where UserEvent: Eq + PartialEq + Clone + PartialOrd + PartialEq,

fn eq(&self, other: &Event<UserEvent>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<UserEvent> PartialOrd for Event<UserEvent>

where UserEvent: Eq + PartialEq + Clone + PartialOrd + PartialOrd,

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<UserEvent> Eq for Event<UserEvent>

where UserEvent: Eq + PartialEq + Clone + PartialOrd + Eq,

impl<UserEvent> StructuralPartialEq for Event<UserEvent>

where UserEvent: Eq + PartialEq + Clone + PartialOrd,