Enum ButtonState 

pub enum ButtonState {
    Down,
    Up,
}

Describes the state a button is in.

Variants

Down

The button is pressed down.

Often emitted in a mousedown event, see also the MDN documentation on that.

Up

The button is not pressed / was just released.

Often emitted in a mouseup event, see also the MDN documentation on that.

Implementations

impl ButtonState

pub const fn event_type(self) -> &'static str

The type name of the corresponding mouse event.

This is either "mousedown" or "mouseup".

pub const fn is_down(self) -> bool

True if the button is pressed down.

pub const fn is_up(self) -> bool

True if the button is released.

Trait Implementations

impl Clone for ButtonState

fn clone(&self) -> ButtonState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ButtonState

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

Formats the value using the given formatter.

impl Default for ButtonState

fn default() -> ButtonState

Returns the “default value” for a type.

impl Hash for ButtonState

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ButtonState

fn cmp(&self, other: &ButtonState) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ButtonState

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

fn partial_cmp(&self, other: &ButtonState) -> 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 Copy for ButtonState

impl Eq for ButtonState

impl StructuralPartialEq for ButtonState