Struct KeyboardEvent 

pub struct KeyboardEvent {
    pub code_type: i32,
    pub event_type: i32,
    pub key_code: i32,
    pub key: String,
    pub text: String,
}

KeyboardEvent objects describe a user interaction with the keyboard; each event describes a single interaction between the user and a key (or combination of a key with modifier keys) on the keyboard. This follows the pattern as set by (javascript)[https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent\]

Note: that only keyCode, key, or text can be set and that the semantics will slightly vary.

Fields

code_type: i32

Type of keycode contained in the keyCode field.

event_type: i32

The type of keyboard event that should be sent to the emulator

key_code: i32

This property represents a physical key on the keyboard (as opposed to the character generated by pressing the key). In other words, this property is a value which isn’t altered by keyboard layout or the state of the modifier keys. This value will be interpreted by the emulator depending on the KeyCodeType. The incoming key code will be translated to an evdev code type and send to the emulator. The values in key and text will be ignored.

key: String

The value of the key pressed by the user, taking into consideration the state of modifier keys such as Shift as well as the keyboard locale and layout. This follows the w3c standard used in browsers. You can find an accurate description of valid values here

Note that some keys can result in multiple evdev events that are delivered to the emulator. for example the Key “A” will result in a sequence: [“Shift”, “a”] -> [0x2a, 0x1e] whereas “a” results in [“a”] -> [0x1e].

Not all documented keys are understood by android, and only printable ASCII [32-127) characters are properly translated.

Keep in mind that there are a set of key values that result in android specific behavior see:

• “AppSwitch”: Behaves as the “Overview” button in android.
• “GoBack”: The Back button.
• “GoHome”: The Home button, which takes the user to the phone’s main screen (usually an application launcher).
• “Power”: The Power button.

text: String

Series of utf8 encoded characters to send to the emulator. An attempt will be made to translate every character will an EvDev event type and send to the emulator as a keypress event. The values in keyCode, eventType, codeType and key will be ignored.

Note that most printable ASCII characters (range [32-127) can be send individually with the “key” param. Do not expect arbitrary UTF symbols to arrive in the emulator (most will be ignored).

Note that it is possible to overrun the keyboard buffer by slamming this endpoint with large quantities of text (>1kb). The clipboard api is better suited for transferring large quantities of text.

Implementations

impl KeyboardEvent

pub fn code_type(&self) -> KeyCodeType

Returns the enum value of code_type, or the default if the field is set to an invalid enum value.

pub fn set_code_type(&mut self, value: KeyCodeType)

Sets code_type to the provided enum value.

pub fn event_type(&self) -> KeyEventType

Returns the enum value of event_type, or the default if the field is set to an invalid enum value.

pub fn set_event_type(&mut self, value: KeyEventType)

Sets event_type to the provided enum value.

Trait Implementations

impl Clone for KeyboardEvent

fn clone(&self) -> KeyboardEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyboardEvent

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

Formats the value using the given formatter.

impl Default for KeyboardEvent

fn default() -> Self

Returns the “default value” for a type.

impl Hash for KeyboardEvent

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 Message for KeyboardEvent

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for KeyboardEvent

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

impl StructuralPartialEq for KeyboardEvent