Enum KeyState

pub enum KeyState {
    Down,
    Up,
}

Describes the state a key is in.

Variants

Down

The key is pressed down.

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

Up

The key is not pressed / was just released.

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

Implementations

impl KeyState

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

The type name of the corresponding key event.

This is either "keydown" or "keyup".

pub const fn is_down(self) -> bool

True if the key is pressed down.

pub const fn is_up(self) -> bool

True if the key is released.

Trait Implementations

impl Clone for KeyState

fn clone(&self) -> KeyState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyState

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

Formats the value using the given formatter.

impl Default for KeyState

fn default() -> KeyState

Returns the “default value” for a type.

impl Hash for KeyState

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

where __H: Hasher,

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 KeyState

fn cmp(&self, other: &KeyState) -> 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 KeyState

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

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

impl Eq for KeyState

impl StructuralPartialEq for KeyState