Struct KeyEvent 

pub struct KeyEvent(/* private fields */);

A key press/release/repeat event.

Implementations

impl KeyEvent

pub fn new(key: Key, state: KeyState) -> Self

pub fn key(&self) -> Key

Returns the Key code that has been pressed/released/repeated.

pub fn state(&self) -> KeyState

Returns the state of the key.

This will be KeyState::RELEASED if the key has been released, KeyState::PRESSED if it has just been pressed, and KeyState::REPEAT if the key has been held down after being pressed.

Methods from Deref<Target = InputEvent>

pub fn time(&self) -> SystemTime

Returns the timestamp stored in the event.

The clock source used to generate event timestamps can be changed by calling Evdev::set_clockid.

pub fn kind(&self) -> EventKind

Returns the EventKind this InputEvent encodes.

EventKind is a matchable, type-safe enum which is intended to be the primary way most applications examine input events.

EventKind is #[non_exhaustive], so matching on it requires a wildcard arm that will catch any events that don’t have a specific EventKind variant. Future versions of evdevil might add new variants to catch those events.

pub fn event_type(&self) -> EventType

Returns the EventType of this event.

pub fn raw_code(&self) -> u16

Returns the raw event code field.

The code of an InputEvent generally describes what entity the event is describing. Depending on the type of event, it can describe a key, axis, sound, LED, or other entity.

pub fn raw_value(&self) -> i32

Returns the raw event value field.

The value of an InputEvent describes the new state of the key, axis, LED, or other entity.

Trait Implementations

impl Clone for KeyEvent

fn clone(&self) -> KeyEvent

Returns a duplicate 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 Deref for KeyEvent

type Target = InputEvent

The resulting type after dereferencing.

fn deref(&self) -> &InputEvent

Dereferences the value.

impl From<KeyEvent> for EventKind

fn from(value: KeyEvent) -> Self

Converts to this type from the input type.

impl From<KeyEvent> for InputEvent

fn from(value: KeyEvent) -> Self

Converts to this type from the input type.

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 Copy for KeyEvent

impl Eq for KeyEvent

impl StructuralPartialEq for KeyEvent