Skip to main content

Key

Enum Key 

Source
pub enum Key {
Show 21 variants Char(char), Shift, Ctrl, Alt, Meta, Enter, Escape, Backspace, Tab, Space, Delete, Insert, ArrowUp, ArrowDown, ArrowLeft, ArrowRight, Home, End, PageUp, PageDown, F(u8),
}
Expand description

A keyboard key.

Modifier keys (Shift, Ctrl, Alt, Meta) are regular variants of this enum — they are not a separate type. This matches the physical reality that modifiers are keys like any other, and the convention of Playwright, Puppeteer, Selenium, pyautogui, SendInput, and XTest.

§Key::Char semantics

Key::Char(c) represents the physical key labeled with the unshifted character c. It does not auto-synthesise Shift. To produce an uppercase letter or shifted symbol, hold Key::Shift explicitly:

// Cmd+A (select all):
keyboard.chord(Key::Char('a'), &[Key::Meta]);

// Uppercase 'A':
keyboard.chord(Key::Char('a'), &[Key::Shift]);

For this reason, Key::Char rejects ASCII uppercase letters at the API boundary (Error::InvalidActionData). This prevents the common footgun where chord(Key::Char('K'), &[Key::Meta]) is read as “Cmd+K” but would silently mean “Cmd+Shift+K” under auto-shift semantics.

To type arbitrary text (with IME support and correct case handling), use Keyboard::type_textKey is for single-key presses.

§Meta

Meta is the platform’s “command” modifier: Cmd on macOS, Win on Windows, Super on Linux. Backends are responsible for the platform mapping.

Variants§

§

Char(char)

A printable character (lowercase, no shifted symbols). Backends translate this to the matching physical key. See the type-level docs for the rationale on rejecting uppercase letters.

§

Shift

§

Ctrl

§

Alt

§

Meta

§

Enter

§

Escape

§

Backspace

§

Tab

§

Space

§

Delete

§

Insert

§

ArrowUp

§

ArrowDown

§

ArrowLeft

§

ArrowRight

§

Home

§

End

§

PageUp

§

PageDown

§

F(u8)

A function key. n is 1-based (F(1) = F1).

Trait Implementations§

Source§

impl Clone for Key

Source§

fn clone(&self) -> Key

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Key

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Hash for Key

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for Key

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for Key

Source§

impl StructuralPartialEq for Key

Auto Trait Implementations§

§

impl Freeze for Key

§

impl RefUnwindSafe for Key

§

impl Send for Key

§

impl Sync for Key

§

impl Unpin for Key

§

impl UnsafeUnpin for Key

§

impl UnwindSafe for Key

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.