Enum crossterm::event::MouseEventKind

source · [−]

pub enum MouseEventKind {
    Down(MouseButton),
    Up(MouseButton),
    Drag(MouseButton),
    Moved,
    ScrollDown,
    ScrollUp,
}

Expand description

A mouse event kind.

Platform-specific Notes

Mouse Buttons

Some platforms/terminals do not report mouse button for the MouseEventKind::Up and MouseEventKind::Drag events. MouseButton::Left is returned if we don’t know which button was used.

Variants

`Down(MouseButton)`

Pressed mouse button. Contains the button that was pressed.

`Up(MouseButton)`

Released mouse button. Contains the button that was released.

`Drag(MouseButton)`

Moved the mouse cursor while pressing the contained mouse button.

`Moved`

Moved the mouse cursor while not pressing a mouse button.

`ScrollDown`

Scrolled mouse wheel downwards (towards the user).

`ScrollUp`

Scrolled mouse wheel upwards (away from the user).

Trait Implementations

source

impl Clone for MouseEventKind

source

fn clone(&self) -> MouseEventKind

Returns a copy 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 MouseEventKind

source

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

Formats the value using the given formatter. Read more

source

impl Hash for MouseEventKind

source

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more

1.3.0 · source

fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,

Feeds a slice of this type into the given Hasher. Read more

source

impl PartialEq<MouseEventKind> for MouseEventKind

source

fn eq(&self, other: &MouseEventKind) -> bool

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

source

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

This method tests for !=.

source

impl PartialOrd<MouseEventKind> for MouseEventKind

source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

source

impl StructuralPartialEq for MouseEventKind

Auto Trait Implementations

impl RefUnwindSafe for MouseEventKind

impl Send for MouseEventKind

impl Sync for MouseEventKind

impl Unpin for MouseEventKind

impl UnwindSafe for MouseEventKind

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · 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,

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)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

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

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

Enum crossterm::event::MouseEventKind

Variants

Down(MouseButton)

Up(MouseButton)

Drag(MouseButton)

Moved

ScrollDown

ScrollUp

Trait Implementations

impl Clone for MouseEventKind

fn clone(&self) -> MouseEventKind

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

impl Debug for MouseEventKind

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

impl Hash for MouseEventKind

fn hash<__H: Hasher>(&self, state: &mut __H)

fn hash_slice<H>(data: &[Self], state: &mut H) where H: Hasher,

impl PartialEq<MouseEventKind> for MouseEventKind

fn eq(&self, other: &MouseEventKind) -> bool

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

impl PartialOrd<MouseEventKind> for MouseEventKind

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

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

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

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

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

impl Copy for MouseEventKind

impl Eq for MouseEventKind

impl StructuralEq for MouseEventKind

impl StructuralPartialEq for MouseEventKind

Auto Trait Implementations

impl RefUnwindSafe for MouseEventKind

impl Send for MouseEventKind

impl Sync for MouseEventKind

impl Unpin for MouseEventKind

impl UnwindSafe for MouseEventKind

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

`Down(MouseButton)`

`Up(MouseButton)`

`Drag(MouseButton)`

`Moved`

`ScrollDown`

`ScrollUp`

fn hash<H: Hasher>(&self, state: &mut H)

fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,

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

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

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

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

impl<T> ToOwned for T where
T: Clone,

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

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