Struct KeyOutput

pub struct KeyOutput { /* private fields */ }

Struct for the output from KeyState.

Implementations

impl KeyOutput

pub const NO_OUTPUT: KeyOutput

A key output with no key code and no modifiers.

pub const fn from_usage(key_usage: KeyUsage) -> Self

Constructs a KeyOutput from a key usage.

pub const fn from_usage_with_modifiers( key_usage: KeyUsage, key_modifiers: KeyboardModifiers, ) -> Self

Constructs a KeyOutput from a key usage.

pub const fn from_key_code(key_code: u8) -> Self

Constructs a KeyOutput from a key code.

pub const fn from_key_code_with_modifiers( key_code: u8, key_modifiers: KeyboardModifiers, ) -> Self

Constructs a KeyOutput from a key code with the given keyboard modifiers.

pub const fn from_key_modifiers(key_modifiers: KeyboardModifiers) -> Self

Constructs a KeyOutput for just the given keyboard modifiers.

pub const fn from_consumer_code(usage_code: u8) -> Self

Constructs a KeyOutput from a consumer code.

pub const fn from_custom_code(custom_code: u8) -> Self

Constructs a KeyOutput from a custom code.

pub const fn from_mouse_output(mouse_output: MouseOutput) -> Self

Constructs a KeyOutput from a mouse output.

pub const fn key_code(&self) -> KeyUsage

Returns the key code value.

pub const fn key_modifiers(&self) -> KeyboardModifiers

Returns the keyboard modifiers of the key output.

Trait Implementations

impl Clone for KeyOutput

fn clone(&self) -> KeyOutput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyOutput

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for KeyOutput

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for KeyOutput

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for KeyOutput

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for KeyOutput

impl Eq for KeyOutput

impl StructuralPartialEq for KeyOutput