Enum KeyState

#[non_exhaustive]
#[repr(u32)]
pub enum KeyState {
    Released = 0,
    Pressed = 1,
    Repeated = 2,
}

physical key state

Describes the physical state of a key that produced the key event.

Since version 10, the key can be in a “repeated” pseudo-state which means the same as “pressed”, but is used to signal repetition in the key event.

The key may only enter the repeated state after entering the pressed state and before entering the released state. This event may be generated multiple times while the key is down.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Released = 0

key is not pressed

Pressed = 1

key is pressed

Repeated = 2

key was repeated

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

Formats the value using the given formatter.

impl From<KeyState> for u32

fn from(val: KeyState) -> u32

Converts to this type from the input type.

impl Hash for KeyState

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 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 TryFrom<u32> for KeyState

type Error = ()

The type returned in the event of a conversion error.

fn try_from(val: u32) -> Result<KeyState, ()>

Performs the conversion.

impl Copy for KeyState

impl Eq for KeyState

impl StructuralPartialEq for KeyState