Skip to main content

InputEvent

Enum InputEvent 

Source
pub enum InputEvent {
    Key {
        code: KeyCode,
        modifiers: KeyModifiers,
    },
    MouseDown(MouseEvent),
    MouseUp(MouseEvent),
    MouseMove(MouseEvent),
    MouseScroll {
        x: u16,
        y: u16,
        delta: i16,
    },
    Resize {
        width: u16,
        height: u16,
    },
    FocusGained,
    FocusLost,
    Paste(String),
    Error(String),
    Shutdown,
}
Expand description

Events from the input thread.

These are sent from the input actor to the main loop.

Variants§

§

Key

A key was pressed.

Fields

§code: KeyCode

The key code.

§modifiers: KeyModifiers

Modifiers held during keypress.

§

MouseDown(MouseEvent)

Mouse button pressed.

§

MouseUp(MouseEvent)

Mouse button released.

§

MouseMove(MouseEvent)

Mouse moved (only if tracking enabled).

§

MouseScroll

Mouse scroll.

Fields

§x: u16

X coordinate.

§y: u16

Y coordinate.

§delta: i16

Scroll delta (positive = up, negative = down).

§

Resize

Terminal was resized.

Fields

§width: u16

New width in columns.

§height: u16

New height in rows.

§

FocusGained

Focus gained.

§

FocusLost

Focus lost.

§

Paste(String)

Paste event (bracketed paste).

§

Error(String)

Input thread encountered an error.

§

Shutdown

Input thread is shutting down.

Trait Implementations§

Source§

impl Clone for InputEvent

Source§

fn clone(&self) -> InputEvent

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.