Struct KeyEvent

pub struct KeyEvent {
    pub timestamp: Option<i64>,
    pub type_: Option<KeyEventType>,
    pub key: Option<Key>,
    pub modifiers: Option<Modifiers>,
    pub key_meaning: Option<KeyMeaning>,
    pub repeat_sequence: Option<u32>,
    pub lock_state: Option<LockState>,
    pub device_id: Option<u32>,
    /* private fields */
}

A Keyboard event generated to reflect key input. timestamp and type are required. At least one of key and key_meaning must be set for a valid event.

Fields

timestamp: Option<i64>

Time in nanoseconds when the event was recorded, in the CLOCK_MONOTONIC time base. The timestamp is required on every key event, and users can expect that it will always be present.

type_: Option<KeyEventType>

Type of event.

key: Option<Key>

Identifies the key ignoring modifiers, layout, prior key events, etc. This is called the “physical key” on some platforms. In cases where the key event did not originate from a physical keyboard (e.g. onscreen keyboard) this field may be empty.

modifiers: Option<Modifiers>

Modifiers in effect at the time of the event. Example: CapsLock is off, user presses CapsLock, then A, then releases both. Event sequence is as follows:

1. type: Pressed, key: CapsLock, modifiers: None
2. type: Pressed, key: A, modifiers: CapsLock
3. type: Released, key: CapsLock, modifiers: CapsLock
4. type: Released, key: A, modifiers: CapsLock

CapsLock is on, user presses CapsLock, then A, then releases both.

1. type: Pressed, key: CapsLock, modifiers: CapsLock
2. type: Pressed, key: A, modifiers: None
3. type: Released, key: CapsLock, modifiers: None
4. type: Released, key: A, modifiers: None

key_meaning: Option<KeyMeaning>

Meaning of the key.

repeat_sequence: Option<u32>

The sequence number of this KeyEvent in the sequence of autorepeated keys.

Unset if this event has been generated in the immediate response to an input from the keyboard driver. If the KeyEvent has been generated through the autorepeat mechanism, this property is set and is incremented by one for each successive generated key event.

lock_state: Option<LockState>

The lock state in effect at the time of the event.

For example, if CapsLock effect is turned on (pressing ‘a’ results in the effect ‘A’), the corresponding bit in the lock state is set.

NOTE: LockState is different from whether the CapsLock modifier key is actuated or not. LockState.CAPS_LOCK can be active even if the Caps Lock key is not currently actuated.

device_id: Option<u32>

Identifies the device originating this event.

Trait Implementations

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<D: ResourceDialect> Decode<KeyEvent, D> for KeyEvent

fn new_empty() -> Self

Creates a valid instance of Self. The specific value does not matter, since it will be overwritten by decode.

unsafe fn decode( &mut self, decoder: &mut Decoder<'_, D>, offset: usize, depth: Depth, ) -> Result<()>

Decodes an object of type T from the decoder’s buffers into self.

impl Default for KeyEvent

fn default() -> KeyEvent

Returns the “default value” for a type.

impl<D: ResourceDialect> Encode<KeyEvent, D> for &KeyEvent

unsafe fn encode( self, encoder: &mut Encoder<'_, D>, offset: usize, depth: Depth, ) -> Result<()>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID.

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

type Owned = KeyEvent

The owned Rust type which this FIDL type decodes into.

fn inline_align(_context: Context) -> usize

Returns the minimum required alignment of the inline portion of the encoded object. It must be a (nonzero) power of two.

fn inline_size(_context: Context) -> usize

Returns the size of the inline portion of the encoded object, including padding for alignment. Must be a multiple of inline_align.

fn encode_is_copy() -> bool

Returns true if the memory layout of Self::Owned matches the FIDL wire format and encoding requires no validation. When true, we can optimize encoding arrays and vectors of Self::Owned to a single memcpy.

fn decode_is_copy() -> bool

Returns true if the memory layout of Self::Owned matches the FIDL wire format and decoding requires no validation. When true, we can optimize decoding arrays and vectors of Self::Owned to a single memcpy.

impl ValueTypeMarker for KeyEvent

type Borrowed<'a> = &'a KeyEvent

The Rust type to use for encoding. This is a particular Encode<Self> type cheaply obtainable from &Self::Owned. There are three cases:

fn borrow(value: &<Self as TypeMarker>::Owned) -> Self::Borrowed<'_>

Cheaply converts from &Self::Owned to Self::Borrowed.

impl Persistable for KeyEvent

impl StructuralPartialEq for KeyEvent