Struct InputEvent

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

An input event received from or sent to an evdev.

Use InputEvent::kind to convert it to a matchable enum.

Implementations

impl InputEvent

pub const fn new(ty: EventType, raw_code: u16, raw_value: i32) -> Self

Creates an InputEvent from raw values.

The timestamp of the event will be set to 0.

pub const fn zeroed() -> Self

Creates an InputEvent with all fields zeroed out.

Useful as a dummy or filler value that will be overwritten with a “real” event soon.

This results in a Syn::REPORT event.

pub fn with_time(self, time: SystemTime) -> Self

Changes the timestamp of self to the given SystemTime.

Note: InputEvent uses a timeval to store the timestamp, which has microsecond resolution, while SystemTime can represent nanoseconds on Unix. The value will be truncated or rounded to fit in the timeval.

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 about. 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 InputEvent

fn clone(&self) -> InputEvent

Returns a duplicate 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<AbsEvent> for InputEvent

fn from(value: AbsEvent) -> Self

Converts to this type from the input type.

impl From<EventKind> for InputEvent

fn from(kind: EventKind) -> InputEvent

Converts to this type from the input type.

impl From<ForceFeedbackEvent> for InputEvent

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

fn from(value: LedEvent) -> Self

Converts to this type from the input type.

impl From<MiscEvent> for InputEvent

fn from(value: MiscEvent) -> Self

Converts to this type from the input type.

impl From<RelEvent> for InputEvent

fn from(value: RelEvent) -> Self

Converts to this type from the input type.

impl From<RepeatEvent> for InputEvent

fn from(value: RepeatEvent) -> Self

Converts to this type from the input type.

impl From<SoundEvent> for InputEvent

fn from(value: SoundEvent) -> Self

Converts to this type from the input type.

impl From<SwitchEvent> for InputEvent

fn from(value: SwitchEvent) -> Self

Converts to this type from the input type.

impl From<Syn> for InputEvent

fn from(value: Syn) -> Self

Converts to this type from the input type.

impl From<SynEvent> for InputEvent

fn from(value: SynEvent) -> Self

Converts to this type from the input type.

impl From<UinputEvent> for InputEvent

fn from(value: UinputEvent) -> Self

Converts to this type from the input type.

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