Struct KeyboardInput

#[repr(C, packed(1))]
pub struct KeyboardInput { /* private fields */ }

Keyboard input report

Implementations

impl KeyboardInput

pub fn pressed(&self) -> AllPressedKeys<'_>

Get iterator over pressed keys

Modifiers also returned as key codes before ordinary keys

pub fn mods(&self) -> Modifiers

Get modifier mask

pub fn count_pressed(&self) -> usize

Get number of all pressed keys

pub fn count_pressed_mods(&self) -> usize

Get number of pressed modifiers

pub fn count_pressed_keys(&self) -> usize

Get number of pressed keys excepting modifiers

pub fn pressed_keys(&self) -> &[Key]

Get slice of pressed keys excepting modifiers

pub fn is_pressed_key(&self, key: Key) -> bool

Check is key pressed excepting modifiers

pub fn change_mods(&mut self, mask: Modifiers, state: bool)

Press or release modifiers only

pub fn press_mods(&mut self, mask: Modifiers)

Press modifiers only

pub fn release_mods(&mut self, mask: Modifiers)

Release modifiers only

pub fn change_key(&mut self, key: Key, state: bool)

Press or release key

pub fn press_key(&mut self, key: Key)

Press key

pub fn release_key(&mut self, key: Key)

Release key

pub fn diff<'i>(&'i self, other: &'i KeyboardInput) -> KeyStateChanges<'i>

Get key state changes between two reports

Difference of two reports

Trait Implementations

impl AsMut<[u8]> for KeyboardInput

fn as_mut(&mut self) -> &mut [u8]

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<[u8]> for KeyboardInput

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for KeyboardInput

fn clone(&self) -> KeyboardInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KeyboardInput

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

Formats the value using the given formatter.

impl Default for KeyboardInput

fn default() -> KeyboardInput

Returns the “default value” for a type.

impl Extend<KeyboardInput> for KeyboardInput

fn extend<T>(&mut self, iter: T)

where T: IntoIterator<Item = KeyboardInput>,

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl Extend<StateChange<Key>> for KeyboardInput

fn extend<T>(&mut self, iter: T)

where T: IntoIterator<Item = StateChange<Key>>,

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl Extend<StateChange<Modifiers>> for KeyboardInput

fn extend<T>(&mut self, iter: T)

where T: IntoIterator<Item = StateChange<Modifiers>>,

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl<'i> Sub for &'i KeyboardInput

type Output = KeyStateChanges<'i>

The resulting type after applying the - operator.

fn sub(self, other: &'i KeyboardInput) -> <&'i KeyboardInput as Sub>::Output

Performs the - operation.

impl Copy for KeyboardInput