Struct InputEvent

#[repr(C)]
pub struct InputEvent {
    pub time: EventTime,
    pub kind: EventKind,
    pub code: u16,
    pub value: i32,
}

A generic event.

Fields

time: EventTime

The timestamp associated with the event.

kind: EventKind

The type of event that occurred.

code: u16

The code of the event.

The meaning of this code depends on the kind of event. Using the typed events via Event and EventRef is recommended.

value: i32

The value of the event.

The interpretation of this value depends on the kind of event.

Implementations

impl InputEvent

pub const fn zeroed() -> Self

Constructs an empty event.

pub fn with_raw(event: input_event) -> Result<Self, RangeError>

Reinterprets a raw input_event.

pub unsafe fn with_raw_unchecked(event: input_event) -> Self

Reinterprets a raw input_event.

Safety

The input event must have a valid event kind.

pub fn into_bytes(self) -> [u8; 16]

Reinterpret this event as an array of bytes.

pub fn as_bytes(&self) -> &[u8; 16]

Reinterpret this event as a byte slice.

pub unsafe fn as_bytes_mut(&mut self) -> &mut [u8; 16]

Reinterpret this event as a mutable byte slice.

impl InputEvent

pub fn from_raw(event: &input_event) -> Result<&Self, RangeError>

Reinterprets a raw input_event reference.

pub unsafe fn from_raw_unchecked(event: &input_event) -> &Self

Reinterprets a raw input_event reference.

Safety

The input event must have a valid event kind.

pub fn from_raw_mut(event: &mut input_event) -> Result<&mut Self, RangeError>

Reinterprets a raw input_event into a mutable reference.

pub unsafe fn from_raw_mut_unchecked(event: &mut input_event) -> &mut Self

Reinterprets a raw input_event into a mutable reference.

Safety

The input event must have a valid event kind.

pub fn into_raw(self) -> input_event

Reinterprets the event as a raw input_event.

pub fn as_raw(&self) -> &input_event

Reinterprets the event as a raw input_event reference.

pub unsafe fn as_raw_mut(&mut self) -> &mut input_event

Reinterprets the event as a mutable raw input_event.

Trait Implementations

impl AsRef<InputEvent> for AbsoluteEvent

fn as_ref(&self) -> &InputEvent

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

impl AsRef<InputEvent> for AutorepeatEvent

fn as_ref(&self) -> &InputEvent

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

impl AsRef<InputEvent> for Event

fn as_ref(&self) -> &InputEvent

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

impl<'a> AsRef<InputEvent> for EventMut<'a>

fn as_ref(&self) -> &InputEvent

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

impl<'a> AsRef<InputEvent> for EventRef<'a>

fn as_ref(&self) -> &InputEvent

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

impl AsRef<InputEvent> for ForceFeedbackEvent

fn as_ref(&self) -> &InputEvent

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

impl AsRef<InputEvent> for ForceFeedbackStatusEvent

fn as_ref(&self) -> &InputEvent

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

impl AsRef<InputEvent> for InputEvent

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 RelativeEvent

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 SynchronizeEvent

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<'de> Deserialize<'de> for InputEvent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Encoder<InputEvent> for EventCodec

Available on crate features tokio-util-0_6 and codec only.

type Error = Error

The type of encoding errors.

fn encode( &mut self, item: InputEvent, dst: &mut BytesMut, ) -> Result<(), Self::Error>

Encodes a frame into the buffer provided.

impl Encoder<InputEvent> for EventCodec

Available on crate features tokio-util-0_7 and codec only.

type Error = Error

The type of encoding errors.

fn encode( &mut self, item: InputEvent, dst: &mut BytesMut, ) -> Result<(), Self::Error>

Encodes a frame into the buffer provided.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl<'a, 'b> From<&'a EventMut<'b>> for &'a InputEvent

fn from(event: &'a EventMut<'b>) -> Self

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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 InputEvent

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl From<AbsoluteEvent> for InputEvent

fn from(event: AbsoluteEvent) -> Self

Converts to this type from the input type.

impl From<AutorepeatEvent> for InputEvent

fn from(event: AutorepeatEvent) -> Self

Converts to this type from the input type.

impl From<Event> for InputEvent

fn from(event: Event) -> Self

Converts to this type from the input type.

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

fn from(event: EventMut<'a>) -> Self

Converts to this type from the input type.

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

fn from(event: EventRef<'a>) -> Self

Converts to this type from the input type.

impl From<ForceFeedbackEvent> for InputEvent

fn from(event: ForceFeedbackEvent) -> Self

Converts to this type from the input type.

impl From<ForceFeedbackStatusEvent> for InputEvent

fn from(event: ForceFeedbackStatusEvent) -> Self

Converts to this type from the input type.

impl From<InputEvent> for Event

fn from(event: InputEvent) -> Self

Converts to this type from the input type.

impl From<InputEvent> for input_event

fn from(event: 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<RelativeEvent> for InputEvent

fn from(event: RelativeEvent) -> 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<SynchronizeEvent> for InputEvent

fn from(event: SynchronizeEvent) -> 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 GenericEvent for InputEvent

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

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.

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

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

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

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 AbsoluteEvent

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 InputEvent> for &'a AutorepeatEvent

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 InputEvent> for &'a ForceFeedbackEvent

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 InputEvent> for &'a ForceFeedbackStatusEvent

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 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 InputEvent> for &'a LedEvent

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 InputEvent> for &'a MiscEvent

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 InputEvent> for &'a RelativeEvent

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 InputEvent> for &'a SoundEvent

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 InputEvent> for &'a SwitchEvent

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 InputEvent> for &'a SynchronizeEvent

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 InputEvent> for &'a UInputEvent

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 input_event> for &'a InputEvent

type Error = RangeError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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<'a> TryFrom<&'a mut InputEvent> for &'a mut AutorepeatEvent

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<'a> TryFrom<&'a mut InputEvent> for &'a mut ForceFeedbackEvent

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<'a> TryFrom<&'a mut InputEvent> for &'a mut ForceFeedbackStatusEvent

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<'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<'a> TryFrom<&'a mut InputEvent> for &'a mut LedEvent

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<'a> TryFrom<&'a mut InputEvent> for &'a mut MiscEvent

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<'a> TryFrom<&'a mut InputEvent> for &'a mut RelativeEvent

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<'a> TryFrom<&'a mut InputEvent> for &'a mut SoundEvent

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<'a> TryFrom<&'a mut InputEvent> for &'a mut SwitchEvent

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<'a> TryFrom<&'a mut InputEvent> for &'a mut SynchronizeEvent

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<'a> TryFrom<&'a mut InputEvent> for &'a mut UInputEvent

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<'a> TryFrom<&'a mut input_event> for &'a mut InputEvent

type Error = RangeError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<InputEvent> for AbsoluteEvent

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 TryFrom<InputEvent> for AutorepeatEvent

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 TryFrom<InputEvent> for ForceFeedbackEvent

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 TryFrom<InputEvent> for ForceFeedbackStatusEvent

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

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 TryFrom<InputEvent> for MiscEvent

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 TryFrom<InputEvent> for RelativeEvent

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 TryFrom<InputEvent> for SoundEvent

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 TryFrom<InputEvent> for SwitchEvent

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 TryFrom<InputEvent> for SynchronizeEvent

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 TryFrom<InputEvent> for UInputEvent

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 TryFrom<input_event> for InputEvent

type Error = RangeError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for InputEvent

impl Eq for InputEvent

impl StructuralPartialEq for InputEvent