Enum keytokey::KeyCode

#[repr(u32)]
pub enum KeyCode {
    No,
    ErrorRollOver,
    PostFail,
    ErrorUndefined,
    A,
    B,
    C,
    D,
    E,
    F,
    G,
    H,
    I,
    J,
    K,
    L,
    M,
    N,
    O,
    P,
    Q,
    R,
    S,
    T,
    U,
    V,
    W,
    X,
    Y,
    Z,
    Kb1,
    Kb2,
    Kb3,
    Kb4,
    Kb5,
    Kb6,
    Kb7,
    Kb8,
    Kb9,
    Kb0,
    Enter,
    Escape,
    BSpace,
    Tab,
    Space,
    Minus,
    Equal,
    LBracket,
    RBracket,
    BSlash,
    NonUsHash,
    SColon,
    Quote,
    Grave,
    Comma,
    Dot,
    Slash,
    CapsLock,
    F1,
    F2,
    F3,
    F4,
    F5,
    F6,
    F7,
    F8,
    F9,
    F10,
    F11,
    F12,
    PScreen,
    ScrollLock,
    Pause,
    Insert,
    Home,
    PgUp,
    Delete,
    End,
    PgDown,
    Right,
    Left,
    Down,
    Up,
    NumLock,
    KpSlash,
    KpAsterisk,
    KpMinus,
    KpPlus,
    KpEnter,
    Kp1,
    Kp2,
    Kp3,
    Kp4,
    Kp5,
    Kp6,
    Kp7,
    Kp8,
    Kp9,
    Kp0,
    KpDot,
    NonUsBslash,
    Application,
    LCtrl,
    LShift,
    LAlt,
    LGui,
    RCtrl,
    RShift,
    RAlt,
    RGui,
}

usb key codes mapped into the first private region of unicode USBKeyOut must substract UNICODE_BELOW_256 to create valid u8 values to transmit

Variants

NoErrorRollOverPostFailErrorUndefinedABCDEFGHIJKLMNOPQRSTUVWXYZKb1Kb2Kb3Kb4Kb5Kb6Kb7Kb8Kb9Kb0EnterEscapeBSpaceTabSpaceMinusEqualLBracketRBracketBSlashNonUsHashSColonQuoteGraveCommaDotSlashCapsLockF1F2F3F4F5F6F7F8F9F10F11F12PScreenScrollLockPauseInsertHomePgUpDeleteEndPgDownRightLeftDownUpNumLockKpSlashKpAsteriskKpMinusKpPlusKpEnterKp1Kp2Kp3Kp4Kp5Kp6Kp7Kp8Kp9Kp0KpDotNonUsBslashApplicationLCtrlLShiftLAltLGuiRCtrlRShiftRAltRGui

Methods

impl KeyCode

pub fn is_modifier(self) -> bool

needed to build USB reports

pub fn as_modifier_bit(self) -> u8

needed to build USB reports

pub fn to_u8(self) -> u8

Trait Implementations

impl AcceptsKeycode for KeyCode

fn to_u32(&self) -> u32

impl Debug for KeyCode

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

Formats the value using the given formatter.

impl PartialEq<KeyCode> for KeyCode

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Eq for KeyCode

impl Ord for KeyCode

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

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

Restrict a value to a certain interval.

impl PartialOrd<KeyCode> for KeyCode

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

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use] fn ge(&self, other: &Rhs) -> bool

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

impl Copy for KeyCode

impl TryFrom<u32> for KeyCode

type Error = String

The type returned in the event of a conversion error.

fn try_from(number: u32) -> Result<Self, String>

Performs the conversion.

impl TryFrom<u8> for KeyCode

type Error = String

The type returned in the event of a conversion error.

fn try_from(ii: u8) -> Result<KeyCode, Self::Error>

Performs the conversion.

impl From<KeyCode> for u32

fn from(number: KeyCode) -> Self

Performs the conversion.

impl Clone for KeyCode

fn clone(&self) -> KeyCode

Returns a copy of the value.

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

Performs copy-assignment from source.