Skip to main content

InputEvent

Enum InputEvent 

Source
pub enum InputEvent {
    Key(KeyEvent),
    Mouse(MouseEvent),
    Tick,
}
Expand description

An input event that can be handled by the application.

InputEvent wraps the different types of input the application can receive: keyboard events, mouse events, and periodic tick events for animations or updates.

Use handle to dispatch the event to the appropriate keybinding or pointer handler.

§Example

ⓘ
match crossterm::event::read()? {
    Event::Key(key) => InputEvent::Key(key).handle(&mut world, &active_widgets),
    Event::Mouse(mouse) => InputEvent::Mouse(mouse).handle(&mut world, &active_widgets),
    _ => {}
}

Variants§

§

Key(KeyEvent)

A keyboard event.

§

Mouse(MouseEvent)

A mouse event (click, drag, scroll, etc.).

§

Tick

A periodic tick event for animations or timed updates.

Implementations§

Source§

impl InputEvent

Source

pub fn handle(self, world: &mut World, ids: &[WidgetId])

Handles the event by dispatching to the appropriate handler.

§Panics

Panics if the Keybindings resource is not present in the world.

Trait Implementations§

Source§

impl Debug for InputEvent

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.