Struct KeyEvent

#[repr(C)]
pub struct KeyEvent {
    pub time: EventTime,
    pub key: Key,
    pub value: KeyState,
    /* private fields */
}

An event that indicates the state of a key has changed.

Fields

time: EventTime

The timestamp associated with the event.

key: Key

The key that triggered the event.

value: KeyState

The value of the event.

Implementations

impl<'a> KeyEvent

pub const fn new(time: EventTime, key: Key, value: KeyState) -> Self

Creates a new event from the given code and value.

pub unsafe fn from_event<E: AsRef<input_event>>(event: &E) -> &Self

Reinterpret a generic event without checking for validity.

pub unsafe fn from_event_mut(event: &mut InputEvent) -> &mut Self

Reinterpret a mutable generic event without checking for validity.

pub fn into_event(self) -> InputEvent

A generic input event.

pub fn as_event(&self) -> &InputEvent

A generic input event reference.

pub unsafe fn as_event_mut(&mut self) -> &mut InputEvent

A mutable generic input event reference.

Trait Implementations

impl AsRef<InputEvent> for KeyEvent

fn as_ref(&self) -> &InputEvent

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<input_event> for KeyEvent

fn as_ref(&self) -> &input_event

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for KeyEvent

fn clone(&self) -> KeyEvent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KeyEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for KeyEvent

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> From<&'a KeyEvent> for &'a InputEvent

fn from(event: &'a KeyEvent) -> Self

Converts to this type from the input type.

impl<'a> From<&'a KeyEvent> for EventRef<'a>

fn from(event: &'a KeyEvent) -> Self

Converts to this type from the input type.

impl<'a> From<&'a KeyEvent> for InputEvent

fn from(event: &'a KeyEvent) -> Self

Converts to this type from the input type.

impl<'a> From<&'a mut KeyEvent> for EventMut<'a>

fn from(event: &'a mut KeyEvent) -> Self

Converts to this type from the input type.

impl From<KeyEvent> for Event

fn from(event: KeyEvent) -> Self

Converts to this type from the input type.

impl From<KeyEvent> for InputEvent

fn from(event: KeyEvent) -> Self

Converts to this type from the input type.

impl GenericEvent for KeyEvent

fn event_kind(&self) -> EventKind

The event kind.

fn time(&self) -> &EventTime

The timestamp associated with the event.

fn code(&self) -> u16

The type code value of the event.

fn value(&self) -> i32

The value associated with the event.

fn with_event(event: InputEvent) -> Result<Self, RangeError>

Interprets a generic event into a concrete event type.

unsafe fn with_event_unchecked(event: InputEvent) -> Self

Interprets a generic event into a concrete event type.

fn from_ref(event: &InputEvent) -> Result<&Self, RangeError>

Interprets a generic event reference into a concrete event type.

fn from_mut(event: &mut InputEvent) -> Result<&mut Self, RangeError>

Interprets a mutable generic event reference into a concrete event type.

impl Hash for KeyEvent

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 KeyEvent

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

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

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> TryFrom<&'a InputEvent> for &'a KeyEvent

type Error = RangeError

The type returned in the event of a conversion error.

fn try_from(event: &'a InputEvent) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a mut InputEvent> for &'a mut KeyEvent

type Error = RangeError

The type returned in the event of a conversion error.

fn try_from(event: &'a mut InputEvent) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<InputEvent> for KeyEvent

type Error = RangeError

The type returned in the event of a conversion error.

fn try_from(event: InputEvent) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for KeyEvent

impl Eq for KeyEvent

impl StructuralPartialEq for KeyEvent