Skip to main content

NamedKey

Enum NamedKey 

Source
#[non_exhaustive]
pub enum NamedKey {
Show 85 variants Alt, AltGraph, CapsLock, Control, Fn, FnLock, Meta, NumLock, ScrollLock, Shift, Super, Hyper, Symbol, Enter, Tab, Space, ArrowDown, ArrowLeft, ArrowRight, ArrowUp, End, Home, PageDown, PageUp, Backspace, Clear, Copy, CrSel, Cut, Delete, EraseEof, ExSel, Insert, Paste, Redo, Undo, Accept, Again, Cancel, ContextMenu, Escape, Execute, Find, Help, Pause, Play, Props, Select, ZoomIn, ZoomOut, Eject, Power, PrintScreen, WakeUp, AudioVolumeDown, AudioVolumeMute, AudioVolumeUp, MediaPlayPause, MediaStop, MediaTrackNext, MediaTrackPrevious, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, F13, F14, F15, F16, F17, F18, F19, F20, F21, F22, F23, F24,
}
Expand description

A named (non-character-producing) key value — the named subset of the W3C UI Events key vocabulary (Enter, ArrowUp, F5, Shift, …). Hosts map their platform’s named keys onto this; anything outside the set surfaces as LogicalKey::Unidentified rather than a host-formatted string, so the contract never leans on a windowing crate’s Debug output.

#[non_exhaustive]: the W3C set is large and grows; match with a wildcard arm, and test mapper coverage against NamedKey::ALL. Per-variant docs are omitted — the names are the W3C spec names and self-describing.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Alt

§

AltGraph

§

CapsLock

§

Control

§

Fn

§

FnLock

§

Meta

§

NumLock

§

ScrollLock

§

Shift

§

Super

§

Hyper

§

Symbol

§

Enter

§

Tab

§

Space

§

ArrowDown

§

ArrowLeft

§

ArrowRight

§

ArrowUp

§

End

§

Home

§

PageDown

§

PageUp

§

Backspace

§

Clear

§

Copy

§

CrSel

§

Cut

§

Delete

§

EraseEof

§

ExSel

§

Insert

§

Paste

§

Redo

§

Undo

§

Accept

§

Again

§

Cancel

§

ContextMenu

§

Escape

§

Execute

§

Find

§

Help

§

Pause

§

Play

§

Props

§

Select

§

ZoomIn

§

ZoomOut

§

Eject

§

Power

§

PrintScreen

§

WakeUp

§

AudioVolumeDown

§

AudioVolumeMute

§

AudioVolumeUp

§

MediaPlayPause

§

MediaStop

§

MediaTrackNext

§

MediaTrackPrevious

§

F1

§

F2

§

F3

§

F4

§

F5

§

F6

§

F7

§

F8

§

F9

§

F10

§

F11

§

F12

§

F13

§

F14

§

F15

§

F16

§

F17

§

F18

§

F19

§

F20

§

F21

§

F22

§

F23

§

F24

Implementations§

Source§

impl NamedKey

Source

pub const ALL: &'static [NamedKey]

Every variant, in declaration order.

The enum is #[non_exhaustive], so a host input mapper cannot prove coverage with an exhaustive match; its totality test iterates this slice instead (see damascene-winit’s tests for the pattern).

Trait Implementations§

Source§

impl Clone for NamedKey

Source§

fn clone(&self) -> NamedKey

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for NamedKey

Source§

impl Debug for NamedKey

Source§

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

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

impl Eq for NamedKey

Source§

impl Hash for NamedKey

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 NamedKey

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for NamedKey

Auto Trait Implementations§

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,

Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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.