Struct Key 

pub struct Key {
    pub code: KeyCode,
    pub modifier: KeyModifier,
}

Represents a keyboard key and its modifier.

This struct contains a KeyCode and a KeyModifier.

Fields

• code - The code of the key.
• modifier - The modifier of the key.

Fields

code: KeyCode

modifier: KeyModifier

Implementations

impl Key

pub const None: Key

Represents a non-existent key.

pub fn new(code: KeyCode, modifier: KeyModifier) -> Key

Creates a new key with the given code and modifier.

Arguments

• code - The code of the key.
• modifier - The modifier of the key.

Returns

A new key created from the code and modifier.

Example

use appcui::prelude::*;
 
let key = Key::new(KeyCode::A, KeyModifier::Shift|KeyModifier::Alt);

pub fn create_hotkey(character: char, modifier: KeyModifier) -> Key

Creates a new key from a character and a modifier.

Arguments

• character - The character to create the key from.
• modifier - The modifier of the key.

Returns

A new key created from the character and modifier.

Example

use appcui::prelude::*;
 
let key = Key::create_hotkey('a', KeyModifier::Alt);

pub fn value(&self) -> u16

Returns the value of the key as a u16. This is usually used in combination with the macro key! in a match statement.

Returns

The value of the key as a u16.

Example

use appcui::prelude::*;
 
let key = Key::new(KeyCode::A, KeyModifier::Shift);
let value = key.value();

Trait Implementations

impl Clone for Key

fn clone(&self) -> Key

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Key

impl Debug for Key

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

Formats the value using the given formatter.

impl Default for Key

fn default() -> Self

Returns the “default value” for a type.

impl Display for Key

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

Formats the value using the given formatter.

impl Eq for Key

impl From<KeyCode> for Key

fn from(value: KeyCode) -> Self

Creates a new key from a KeyCode.

Arguments

• value - The KeyCode to create the key from.

Returns

A new key created from the KeyCode.

impl From<char> for Key

fn from(value: char) -> Self

Creates a new key from a character.

Arguments

• value - The character to create the key from.

Returns

A new key created from the character.

Example

use appcui::prelude::*;
 
let key = Key::from('a');

impl From<u16> for Key

fn from(value: u16) -> Self

Creates a new key from a u16 (that was obtained from the value method). If the u16 is not a valid key, the function will return Key::None.

Arguments

• value - The u16 to create the key from.

Returns

A new key created from the u16.

Example

use appcui::prelude::*;
 
let key = Key::from(0x0010);

impl PartialEq for Key

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Key