Struct InputEvent

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

Available on Unix only.

A wrapped input_event returned by the input device via the kernel.

input_event is a struct containing four fields:

• time: timeval
• type_: u16
• code: u16
• value: s32

The meaning of the “code” and “value” fields will depend on the underlying type of event.

Implementations

impl InputEvent

pub fn timestamp(&self) -> SystemTime

Returns the timestamp associated with the event.

pub fn event_type(&self) -> EventType

Returns the type of event this describes, e.g. Key, Switch, etc.

pub fn code(&self) -> u16

Returns the raw “code” field directly from input_event.

pub fn value(&self) -> i32

Returns the raw “value” field directly from input_event.

For keys and switches the values 0 and 1 map to pressed and not pressed respectively. For axes, the values depend on the hardware and driver implementation.

pub fn destructure(self) -> EventSummary

A convenience function to destructure the InputEvent into a EventSummary.

Example

use evdev::*;
let event =  InputEvent::new(1, KeyCode::KEY_A.0, 1);
match event.destructure() {
    EventSummary::Key(KeyEvent, KeyCode::KEY_A, 1) => (),
    _=> panic!(),
}

pub fn new(type_: u16, code: u16, value: i32) -> Self

Create a new InputEvent. Only really useful for emitting events on virtual devices.

pub fn new_now(type_: u16, code: u16, value: i32) -> Self

Create a new InputEvent with the time field set to “now” on the system clock.

Note that this isn’t usually necessary simply for emitting events on a virtual device, as even though InputEvent::new creates an input_event with the time field as zero, the kernel will update input_event.time when it emits the events to any programs reading the event “file”.

Trait Implementations

impl AsRef<InputEvent> for AbsoluteAxisEvent

fn as_ref(&self) -> &InputEvent

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

impl AsRef<InputEvent> for FFEvent

fn as_ref(&self) -> &InputEvent

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

impl AsRef<InputEvent> for FFStatusEvent

fn as_ref(&self) -> &InputEvent

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

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<InputEvent> for LedEvent

fn as_ref(&self) -> &InputEvent

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

impl AsRef<InputEvent> for MiscEvent

fn as_ref(&self) -> &InputEvent

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

impl AsRef<InputEvent> for OtherEvent

fn as_ref(&self) -> &InputEvent

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

impl AsRef<InputEvent> for PowerEvent

fn as_ref(&self) -> &InputEvent

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

impl AsRef<InputEvent> for RelativeAxisEvent

fn as_ref(&self) -> &InputEvent

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

impl AsRef<InputEvent> for RepeatEvent

fn as_ref(&self) -> &InputEvent

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

impl AsRef<InputEvent> for SoundEvent

fn as_ref(&self) -> &InputEvent

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

impl AsRef<InputEvent> for SwitchEvent

fn as_ref(&self) -> &InputEvent

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

impl AsRef<InputEvent> for SynchronizationEvent

fn as_ref(&self) -> &InputEvent

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

impl AsRef<InputEvent> for UInputEvent

fn as_ref(&self) -> &InputEvent

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

impl AsRef<input_event> for InputEvent

fn as_ref(&self) -> &input_event

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

impl Clone for InputEvent

fn clone(&self) -> InputEvent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InputEvent

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

Formats the value using the given formatter.

impl From<AbsoluteAxisEvent> for InputEvent

fn from(event: AbsoluteAxisEvent) -> Self

Converts to this type from the input type.

impl From<FFEvent> for InputEvent

fn from(event: FFEvent) -> Self

Converts to this type from the input type.

impl From<FFStatusEvent> for InputEvent

fn from(event: FFStatusEvent) -> Self

Converts to this type from the input type.

impl From<InputEvent> for EventSummary

fn from(value: InputEvent) -> Self

Converts to this type from the input type.

impl From<InputEvent> for input_event

fn from(wrapper: InputEvent) -> 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 From<LedEvent> for InputEvent

fn from(event: LedEvent) -> Self

Converts to this type from the input type.

impl From<MiscEvent> for InputEvent

fn from(event: MiscEvent) -> Self

Converts to this type from the input type.

impl From<OtherEvent> for InputEvent

fn from(event: OtherEvent) -> Self

Converts to this type from the input type.

impl From<PowerEvent> for InputEvent

fn from(event: PowerEvent) -> Self

Converts to this type from the input type.

impl From<RelativeAxisEvent> for InputEvent

fn from(event: RelativeAxisEvent) -> Self

Converts to this type from the input type.

impl From<RepeatEvent> for InputEvent

fn from(event: RepeatEvent) -> Self

Converts to this type from the input type.

impl From<SoundEvent> for InputEvent

fn from(event: SoundEvent) -> Self

Converts to this type from the input type.

impl From<SwitchEvent> for InputEvent

fn from(event: SwitchEvent) -> Self

Converts to this type from the input type.

impl From<SynchronizationEvent> for InputEvent

fn from(event: SynchronizationEvent) -> Self

Converts to this type from the input type.

impl From<UInputEvent> for InputEvent

fn from(event: UInputEvent) -> Self

Converts to this type from the input type.

impl From<input_event> for InputEvent

fn from(raw: input_event) -> Self

Converts to this type from the input type.

impl Hash for InputEvent

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 PartialEq for InputEvent

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

impl Eq for InputEvent

impl StructuralPartialEq for InputEvent