Enum DeviceStableId 

pub enum DeviceStableId {
    Bolt {
        receiver_uid: String,
        slot: u8,
    },
    Direct {
        vendor_id: u16,
        product_id: u16,
        identity: DeviceIdentity,
    },
    RawHid {
        vendor_id: u16,
        product_id: u16,
        usage_page: u16,
        usage_id: u16,
        identity: String,
    },
    Unknown {
        slot: u8,
        identity: DeviceIdentity,
    },
}

A route-derived identity used to order devices deterministically.

Receiver UID + slot and serial/non-zero unit identities are stable and unique. OS-node identities on raw HID routes are deliberately retained here only so a transient inventory record can still be ordered; they cannot become a PhysicalDeviceKey.

Variants

Bolt

Paired to a receiver — Bolt and Unifying share this variant so order agrees regardless of receiver family.

Fields

receiver_uid: String

Case-folded receiver unique id.

slot: u8

Pairing slot on the receiver.

Direct

Attached straight to the host (USB or Bluetooth), disambiguated by its own DeviceIdentity.

Fields

vendor_id: u16

USB vendor id.

product_id: u16

USB product id.

identity: DeviceIdentity

Disambiguates two same-model direct devices.

RawHid

A standalone raw-HID device, addressed by its USB/usage identifiers plus an OS-node- or serial-derived identity string.

Fields

vendor_id: u16

USB vendor id.

product_id: u16

USB product id.

usage_page: u16

HID usage page.

usage_id: u16

HID usage id.

identity: String

Case-folded OS-node- or serial-derived identity.

Unknown

No route was reported; ordered by pairing slot plus its own DeviceIdentity.

Fields

slot: u8

Pairing slot, when known.

identity: DeviceIdentity

Disambiguates two same-model routeless devices.

Implementations

impl DeviceStableId

pub fn from_parts( route: Option<&DeviceRoute>, slot: u8, serial: Option<&str>, unit_id: [u8; 4], ) -> Self

Build the stable id from a device’s route plus its identity fields. slot is only consulted for a routeless device (the Bolt/Direct cases carry their own slot / addressing inside the route).

pub fn runtime_key(&self) -> String

Route-derived key used while a device is present in a runtime snapshot.

Unlike Self::physical_key, this also represents a direct or routeless device whose only reported identity is an all-zero unit id. Such a key is suitable for short-lived UI bookkeeping only and must not be written to configuration.

This intentionally keys receiver-connected devices by receiver UID + pairing slot rather than model id, so two identical mice paired to the same receiver can carry different settings.

pub fn physical_key(&self) -> Option<PhysicalDeviceKey>

Stable key for persisted per-physical-device configuration.

Receiver-connected devices are identified by receiver UID + pairing slot. Direct and routeless devices require either a non-empty serial number or a non-zero unit id. Raw HID devices require a serial-backed route identity; OS node identities and all-zero unit ids are transient probe results, not physical identities.

Trait Implementations

impl Clone for DeviceStableId

fn clone(&self) -> DeviceStableId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DeviceStableId

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

Formats the value using the given formatter.

impl Eq for DeviceStableId

impl Ord for DeviceStableId

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for DeviceStableId

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