Enum FunctionKey 

pub enum FunctionKey {
    Esc,
    F1,
    F2,
    F3,
    F4,
    F5,
    F6,
    F7,
    F8,
    F9,
    F10,
    F11,
    F12,
    F13,
    F14,
    F15,
    F16,
    F17,
    F18,
    F19,
}

A key of the programmable top row.

Variants

Esc

Escape.

F1

F1.

F2

F2.

F3

F3.

F4

F4.

F5

F5.

F6

F6.

F7

F7.

F8

F8.

F9

F9.

F10

F10.

F11

F11.

F12

F12.

F13

F13.

F14

F14.

F15

F15.

F16

F16.

F17

F17.

F18

F18.

F19

F19.

Implementations

impl FunctionKey

pub const ALL: [Self; 20]

Every key, in the order the row is laid out.

pub const fn keycode(self) -> u16

The macOS virtual keycode (kVK_*). Key events and triggers carry this keycode on every platform, so a config written on one host binds the same key on another.

pub fn from_keycode(keycode: u16) -> Option<Self>

The key a macOS virtual keycode names, if it is on this row.

pub const fn name(self) -> &'static str

The name a trigger is written with: esc, f1 … f19.

pub fn from_name(name: &str) -> Option<Self>

The key a trigger name spells, case-insensitively.

pub const fn label(self) -> &'static str

The legend printed on the key: Esc, F1 … F19.

pub fn nth_f(n: u16) -> Option<Self>

The nth F key, counting from 1 — how a platform whose own keycodes number the F keys consecutively finds the key it saw. None past F19.

Trait Implementations

impl Clone for FunctionKey

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for FunctionKey

impl Debug for FunctionKey

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

Formats the value using the given formatter.

impl Eq for FunctionKey

impl Hash for FunctionKey

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for FunctionKey

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for FunctionKey

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for FunctionKey

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for FunctionKey