Struct keyboard_types::webdriver::KeyInputState

pub struct KeyInputState {
    pressed: HashSet<Key>,
    modifiers: Modifiers,
}

Store pressed keys and modifiers.

Spec: https://w3c.github.io/webdriver/#dfn-key-input-state

Fields

pressed: HashSet<Key>

modifiers: Modifiers

Implementations

impl KeyInputState

pub fn new() -> KeyInputState

New state without any keys or modifiers pressed.

Same as the default value.

pub fn dispatch_keydown(&mut self, raw_key: char) -> KeyboardEvent

Get a keyboard-keydown event from a WebDriver key value.

Stores that the key is pressed in the state object.

The input cancel list is not implemented here but can be emulated by adding the raw_key value with a keyUp action to a list before executing this function.

Specification: https://w3c.github.io/webdriver/#dfn-dispatch-a-keydown-action

pub fn dispatch_keyup(&mut self, raw_key: char) -> Option<KeyboardEvent>

Get a keyboard-keyup event from a WebDriver key value.

Updates state. Returns None if the key is not listed as pressed.

Specification: https://w3c.github.io/webdriver/#dfn-dispatch-a-keyup-action

fn clear(&mut self, undo_actions: &mut HashSet<char>, result: &mut Vec<Event>)

fn dispatch_typeable(&mut self, text: &mut String, result: &mut Vec<Event>)

Trait Implementations

impl Clone for KeyInputState

fn clone(&self) -> KeyInputState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KeyInputState

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

Formats the value using the given formatter.

impl Default for KeyInputState

fn default() -> KeyInputState

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for KeyInputState

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for KeyInputState

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.