Enum KeyEventType

#[repr(u32)]
pub enum KeyEventType {
    Pressed = 1,
    Released = 2,
    Sync = 3,
    Cancel = 4,
}

Type of the keyboard key input event.

We do not expect new values to be added into this enum.

Variants

Pressed = 1

Key is actuated.

Receiving this event type means that a key has been actuated at the timestamp when the event is received, and while the event recipient is focused.

For example, if the key is a keyboard key, then it was just pressed.

Released = 2

Key is no longer actuated.

Receiving this event type means that a key has been de-actuated at the timestamp when the event is received, and while the event recipient is focused.

For example, if the key is a keyboard key, then it was just released.

Sync = 3

Key was actuated while the client wasn’t able to receive it, and is still actuated now that the client is able to receive key events.

This may happen in a few ways:

• A new device was connected while its key was actuated.
• The key was actuated while the event recipient did not have focus.

Therefore, this is not a “regular” key actuation. It reports now that the key has been actuated in the unknown past. Some event recipients may therefore decide that this is not an actionable key event, while some others may decide that it is.

For example, recipients that trigger some user action may decide to ignore SYNC events, to avoid spurious actions. In contrast, recipients that keep track of the keyboard state may want to consider a SYNC event as a signal to update the key’s state to actuated.

Cancel = 4

Key may have been actuated, but its actuation has become invalid due to an event other than a key de-actuation.

This may happen in a few ways:

• A device was disconnected while its key was actuated.
• The event recipient just lost focus.

Therefore, this is not a “regular” key de-actuation. It reports the key is no longer validly actuated due to an event other than a key release. Some event recipients may therefore decide that this is not an actionable key event, while some others may decide that it is.

For example, recipients which trigger some user action may decide to ignore CANCEL events, to avoid spurious actions. In contrast, recipients that keep track of the keyboard state may want to consider a CANCEL event as a signal to update the key’s state to being de-actuated.

Implementations

impl KeyEventType

pub fn from_primitive(prim: u32) -> Option<KeyEventType>

pub const fn into_primitive(self) -> u32

pub fn is_unknown(&self) -> bool

👎Deprecated: Strict enums should not use is_unknown

Trait Implementations

impl Clone for KeyEventType

fn clone(&self) -> KeyEventType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KeyEventType

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

Formats the value using the given formatter.

impl<D> Decode<KeyEventType, D> for KeyEventType

where D: ResourceDialect,

fn new_empty() -> KeyEventType

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<(), Error>

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

impl<D> Encode<KeyEventType, D> for KeyEventType

where D: ResourceDialect,

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

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

impl Hash for KeyEventType

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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 KeyEventType

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

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

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

type Owned = KeyEventType

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 KeyEventType

type Borrowed<'a> = KeyEventType

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: &<KeyEventType as TypeMarker>::Owned, ) -> <KeyEventType as ValueTypeMarker>::Borrowed<'_>

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

impl Copy for KeyEventType

impl Eq for KeyEventType

impl StructuralPartialEq for KeyEventType