Struct BasicKeySignal

pub struct BasicKeySignal {
    pub keyboard: Address,
    pub character: Option<char>,
    pub keycode: Option<NonZeroU32>,
}

Information about a key press or release event, excluding the name of the player who pressed or released the key.

This structure, unlike KeySignal, is fully owned. Thus, a typical application which does not care about the player name can convert a KeySignal into a BasicKeySignal in order to regain use of the decode buffer.

Fields

keyboard: Address

The address of the keyboard component.

character: Option<char>

The character that was pressed or released, if any.

This is None if the event does not produce a character. Examples of non-character-producing key events are events related to lock keys, arrow keys, modifier keys, navigation keys, or other special keys.

keycode: Option<NonZeroU32>

The keycode that was pressed or released, if any.

This is None if the event does not have a keycode. One example of a non-keycode-producing key event is a composed character; in this case, the individual keystrokes are not reported, but the composed character is reported as a character without associated keycode. Another example is a Windows key (aka super key) or Menu key, both of which (under some operating systems at least) send key signals with neither character nor keycode filled in.

Trait Implementations

impl Clone for BasicKeySignal

fn clone(&self) -> BasicKeySignal

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BasicKeySignal

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

Formats the value using the given formatter.

impl<'buffer> From<&KeySignal<'buffer>> for BasicKeySignal

fn from(source: &KeySignal<'buffer>) -> Self

Converts to this type from the input type.

impl Hash for BasicKeySignal

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 BasicKeySignal

fn cmp(&self, other: &BasicKeySignal) -> 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.

impl PartialEq for BasicKeySignal

fn eq(&self, other: &BasicKeySignal) -> 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 PartialOrd for BasicKeySignal

fn partial_cmp(&self, other: &BasicKeySignal) -> 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 Eq for BasicKeySignal

impl StructuralPartialEq for BasicKeySignal