Skip to main content

KnownUsage

hid_types::item::usage

Enum KnownUsage

#[non_exhaustive]pub enum KnownUsage {
Show 35 variants
    GenericDesktop(KnownUsage),
    SimulationControls(KnownUsage),
    VrControls(KnownUsage),
    SportControls(KnownUsage),
    GameControls(KnownUsage),
    GenericDeviceControls(KnownUsage),
    KeyboardKeypad(KnownUsage),
    Led(KnownUsage),
    Button(u16),
    Ordinal(u16),
    TelephonyDevice(KnownUsage),
    Consumer(KnownUsage),
    Digitizers(KnownUsage),
    Haptics(KnownUsage),
    PhysicalInputDevice(KnownUsage),
    Unicode(u16),
    Soc(KnownUsage),
    EyeAndHeadTrackers(KnownUsage),
    AuxiliaryDisplay(KnownUsage),
    Sensors(KnownUsage),
    MedicalInstrument(KnownUsage),
    BrailleDisplay(KnownUsage),
    LightingAndIllumination(KnownUsage),
    Monitor(KnownUsage),
    MonitorEnumerated(u16),
    VesaVirtualControls(KnownUsage),
    Power(KnownUsage),
    BatterySystem(KnownUsage),
    BarcodeScanner(KnownUsage),
    Scales(KnownUsage),
    MagneticStripeReader(KnownUsage),
    CameraControl(KnownUsage),
    Arcade(KnownUsage),
    GamingDevice(u16),
    FidoAlliance(KnownUsage),
}

Expand description

A well-known usage id.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

GenericDesktop(KnownUsage)

SimulationControls(KnownUsage)

VrControls(KnownUsage)

SportControls(KnownUsage)

GameControls(KnownUsage)

GenericDeviceControls(KnownUsage)

KeyboardKeypad(KnownUsage)

Led(KnownUsage)

Button(u16)

Ordinal(u16)

TelephonyDevice(KnownUsage)

Consumer(KnownUsage)

Digitizers(KnownUsage)

Haptics(KnownUsage)

PhysicalInputDevice(KnownUsage)

Unicode(u16)

Soc(KnownUsage)

EyeAndHeadTrackers(KnownUsage)

AuxiliaryDisplay(KnownUsage)

Sensors(KnownUsage)

MedicalInstrument(KnownUsage)

BrailleDisplay(KnownUsage)

LightingAndIllumination(KnownUsage)

Monitor(KnownUsage)

MonitorEnumerated(u16)

VesaVirtualControls(KnownUsage)

Power(KnownUsage)

BatterySystem(KnownUsage)

BarcodeScanner(KnownUsage)

Scales(KnownUsage)

MagneticStripeReader(KnownUsage)

CameraControl(KnownUsage)

Arcade(KnownUsage)

GamingDevice(u16)

FidoAlliance(KnownUsage)

Implementations§

impl KnownUsage

pub fn from_page_and_id(page: KnownUsagePage, id: u16) -> Option<Self>

Extract the usage value if it is a known value.

If this returns None it could be for multiple reasons:

The Usage Page does not contain distinct IDs (e.g. Button)
The Usage Page is unknown or reserved.
The Usage Page is known but the Usage value is unknown or reserved.

Trait Implementations§

impl Clone for KnownUsage

fn clone(&self) -> Self

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

impl Copy for KnownUsage

impl Debug for KnownUsage

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

Formats the value using the given formatter. Read more

impl Display for KnownUsage

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

Formats the value using the given formatter. Read more

impl PartialEq for KnownUsage

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

Equality operator ==. Read more

1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more

impl StructuralPartialEq for KnownUsage

Auto Trait Implementations§

impl Freeze for KnownUsage

impl RefUnwindSafe for KnownUsage

impl Send for KnownUsage

impl Sync for KnownUsage

impl Unpin for KnownUsage

impl UnsafeUnpin for KnownUsage

impl UnwindSafe for KnownUsage

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

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

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToString for T
where T: Display + ?Sized,

fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = !

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, !>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.