Struct KeyData 

pub struct KeyData {
    pub time_stamp: Duration,
    pub event_type: KeyEventType,
    pub device_type: KeyEventDeviceType,
    pub physical: u64,
    pub logical: u64,
    pub character: Option<String>,
    pub synthesized: bool,
}

Information about a key event.

Fields

time_stamp: Duration

Time of event dispatch, relative to an arbitrary timeline.

For synthesized events, the time_stamp might not be the actual time that the key press or release happens.

event_type: KeyEventType

The type of the event.

device_type: KeyEventDeviceType

Describes what type of device (keyboard, directional pad, etc.) this event originated from.

physical: u64

The key code for the physical key that has changed.

logical: u64

The key code for the logical key that has changed.

character: Option<String>

Character input from the event.

Ignored for up events.

synthesized: bool

If synthesized is true, this event does not correspond to a native event.

Although most of Flutter’s keyboard events are transformed from native events, some events are not based on native events, and are synthesized only to conform Flutter’s key event model (as documented in the HardwareKeyboard class in the framework).

For example, some key downs or ups might be lost when the window loses focus. Some platforms provide ways to query whether a key is being held. If the embedder detects an inconsistency between its internal record and the state returned by the system, the embedder will synthesize a corresponding event to synchronize the state without breaking the event model.

As another example, macOS treats CapsLock in a special way by sending down and up events at the down of alternate presses to indicate the direction in which the lock is toggled instead of that the physical key is going. A macOS embedder should normalize the behavior by converting a native down event into a down event followed immediately by a synthesized up event, and the native up event also into a down event followed immediately by a synthesized up event.

Synthesized events do not have a trustworthy time_stamp, and should not be processed as if the key actually went down or up at the time of the callback.

A key repeat event is never synthesized.

Implementations

impl KeyData

pub fn to_string_full(&self) -> String

Returns a complete textual description of the information in this object.

Trait Implementations

impl Clone for KeyData

fn clone(&self) -> KeyData

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyData

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

Formats the value using the given formatter.

impl Default for KeyData

fn default() -> KeyData

Returns the “default value” for a type.

impl Display for KeyData

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

Formats the value using the given formatter.

impl Eq for KeyData

impl PartialEq for KeyData

fn eq(&self, other: &KeyData) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for KeyData