Struct DeviceId

pub struct DeviceId(/* private fields */);

Unique identifier of a device event source.

Memory

The internal number is a NonZeroU64, that means that Option<DeviceId> and DeviceId are the same size as u64.

As Hash

The generated internal number has good statistical distribution and can be used as its own hash, although it is not cryptographically safe, as it is simply a sequential counter scrambled using splitmix64.

Static

The unique ID cannot be generated at compile time, but you can use the static_id! macro to declare a lazy static that instantiates the ID.

Implementations

impl DeviceId

pub fn new_unique() -> Self

Generates a new unique ID.

pub fn get(self) -> u64

Retrieve the underlying value.

pub fn sequential(self) -> u64

Un-scramble the underlying value to get the original sequential count number.

If two IDs, id0 and id1 where generated by the same thread then id0.sequential() < id1.sequential().

pub fn from_raw(raw: u64) -> Self

Creates an ID from a raw value.

The value must not be zero, panics if it is, the value must have been provided by get otherwise the ID will not be unique.

pub fn from_sequential(num: u64) -> Self

Creates an ID from a sequential number.

Safety

The value must not be zero, panics if it is, the value must have been provided by sequential otherwise the ID will not be unique.

impl DeviceId

pub fn virtual_keyboard() -> DeviceId

Virtual keyboard ID used in keyboard events generated by code.

pub fn virtual_mouse() -> DeviceId

Virtual mouse ID used in mouse events generated by code.

pub fn virtual_generic() -> DeviceId

Virtual generic device ID used in device events generated by code.

Trait Implementations

impl Clone for DeviceId

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DeviceId

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

Formats the value using the given formatter.

impl Display for DeviceId

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

Formats the value using the given formatter.

impl Hash for DeviceId

fn hash<H>(&self, state: &mut H)

where H: Hasher,

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 PartialEq for DeviceId

fn eq(&self, other: &Self) -> 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 UniqueId for DeviceId

fn new_unique() -> Self

New unique ID.

impl Copy for DeviceId

impl Eq for DeviceId

impl NoUninit for DeviceId

impl PodInOption for DeviceId

impl ZeroableInOption for DeviceId