Struct chromiumoxide::cdp::browser_protocol::input::DispatchKeyEventParams

pub struct DispatchKeyEventParams {

    pub type: DispatchKeyEventType,
    pub modifiers: Option<i64>,
    pub timestamp: Option<TimeSinceEpoch>,
    pub text: Option<String>,
    pub unmodified_text: Option<String>,
    pub key_identifier: Option<String>,
    pub code: Option<String>,
    pub key: Option<String>,
    pub windows_virtual_key_code: Option<i64>,
    pub native_virtual_key_code: Option<i64>,
    pub auto_repeat: Option<bool>,
    pub is_keypad: Option<bool>,
    pub is_system_key: Option<bool>,
    pub location: Option<i64>,
    pub commands: Option<Vec<String>>,
}

Dispatches a key event to the page. dispatchKeyEvent

Fields

type: DispatchKeyEventType

Type of the key event.

modifiers: Option<i64>

Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8 (default: 0).

timestamp: Option<TimeSinceEpoch>

Time at which the event occurred.

text: Option<String>

Text as generated by processing a virtual key code with a keyboard layout. Not needed for for keyUp and rawKeyDown events (default: “”)

unmodified_text: Option<String>

Text that would have been generated by the keyboard if no modifiers were pressed (except for shift). Useful for shortcut (accelerator) key handling (default: “”).

key_identifier: Option<String>

Unique key identifier (e.g., ‘U+0041’) (default: “”).

code: Option<String>

Unique DOM defined string value for each physical key (e.g., ‘KeyA’) (default: “”).

key: Option<String>

Unique DOM defined string value describing the meaning of the key in the context of active modifiers, keyboard layout, etc (e.g., ‘AltGr’) (default: “”).

windows_virtual_key_code: Option<i64>

Windows virtual key code (default: 0).

native_virtual_key_code: Option<i64>

Native virtual key code (default: 0).

auto_repeat: Option<bool>

Whether the event was generated from auto repeat (default: false).

is_keypad: Option<bool>

Whether the event was generated from the keypad (default: false).

is_system_key: Option<bool>

Whether the event was a system key event (default: false).

location: Option<i64>

Whether the event was from the left or right side of the keyboard. 1=Left, 2=Right (default: 0).

commands: Option<Vec<String>>

Editing commands to send with the key event (e.g., ‘selectAll’) (default: []). These are related to but not equal the command names used in document.execCommand and NSStandardKeyBindingResponding. See https://source.chromium.org/chromium/chromium/src/+/main:third_party/blink/renderer/core/editing/commands/editor_command_names.h for valid command names.

Implementations

impl DispatchKeyEventParams

pub fn new(type: impl Into<DispatchKeyEventType>) -> DispatchKeyEventParams

impl DispatchKeyEventParams

pub fn builder() -> DispatchKeyEventParamsBuilder

impl DispatchKeyEventParams

pub const IDENTIFIER: &'static str = "Input.dispatchKeyEvent"

Trait Implementations

impl Clone for DispatchKeyEventParams

fn clone(&self) -> DispatchKeyEventParams

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Command for DispatchKeyEventParams

type Response = DispatchKeyEventReturns

The type of the response this request triggers on the chromium server

fn response_from_value(response: Value) -> Result<Self::Response, Error>

deserialize the response from json

impl Debug for DispatchKeyEventParams

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DispatchKeyEventParams

fn deserialize<__D>( __deserializer: __D ) -> Result<DispatchKeyEventParams, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Method for DispatchKeyEventParams

fn identifier(&self) -> Cow<'static, str>

The whole string identifier for this method like: DOM.removeNode

fn domain_name(&self) -> Cow<'static, str>

The name of the domain this method belongs to: DOM

fn method_name(&self) -> Cow<'static, str>

The standalone identifier of the method inside the domain: removeNode

fn split(&self) -> (Cow<'static, str>, Cow<'static, str>)

Tuple of (domain_name, method_name) : (DOM, removeNode)

impl MethodType for DispatchKeyEventParams

fn method_id() -> Cow<'static, str>

where DispatchKeyEventParams: Sized,

The identifier for this event’s method field

impl PartialEq for DispatchKeyEventParams

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for DispatchKeyEventParams

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for DispatchKeyEventParams