Struct KeyInput 

pub struct KeyInput {
    pub key: String,
    pub text: Option<String>,
    pub code: Option<String>,
    pub key_code: Option<u32>,
    pub location: Option<u32>,
    pub is_keypad: bool,
}

Represents a key definition that can be dispatched to the browser.

Fields

key: String

Display value for the key, for example a or Enter.

text: Option<String>

Optional character produced by the key, forwarded to text/unmodifiedText.

code: Option<String>

DOM code value used by the browser, when known.

key_code: Option<u32>

Platform-specific virtual key code (Windows/native).

location: Option<u32>

Keyboard location (0 = Standard, 1 = Left, 2 = Right, 3 = Numpad).

is_keypad: bool

Marks whether the key originates from the numeric keypad.

Implementations

impl KeyInput

pub fn new(key: impl Into<String>) -> Self

Builds a key definition with the given display value.

pub fn from_char(ch: char) -> Self

Builds a key definition from a single character.

pub fn with_text(self, text: impl Into<String>) -> Self

Sets the character returned by the key.

pub fn with_code(self, code: impl Into<String>) -> Self

Sets the DOM code value for the key.

pub fn with_key_code(self, key_code: u32) -> Self

Populates the virtual key code.

pub fn with_location(self, location: u32) -> Self

Sets the keyboard location value.

pub fn from_keypad(self) -> Self

Marks the key as originating from the numeric keypad.

Trait Implementations

impl Clone for KeyInput

fn clone(&self) -> KeyInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyInput

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

Formats the value using the given formatter.

impl From<&str> for KeyInput

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<String> for KeyInput

fn from(value: String) -> Self

Converts to this type from the input type.

impl From<char> for KeyInput

fn from(value: char) -> Self

Converts to this type from the input type.