Struct Cid 

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

One HID++ 0x1b04 control, by its firmware control ID.

Distinct from the HID++ layer’s own ControlId on purpose: this is the config-facing identity of a rebindable control, and the two crates never depend on each other.

Implementations

impl Cid

pub const fn new(cid: u16) -> Self

Wrap a raw 0x1b04 control ID.

pub const fn raw(self) -> u16

The raw control ID as the firmware reports it.

pub fn known(self) -> Option<&'static KnownControl>

The catalog row for this control, when OpenLogi knows it.

pub fn from_config_name(name: &str) -> Option<Self>

The control a config name denotes: a catalog name such as KeyScreenCapture, or the control:0x… form any control has.

pub fn config_name(self) -> Cow<'static, str>

The name this control is written with in config.toml: its catalog name when it has one, else control:0x…. Stable — a control that later gains a catalog row keeps loading under its numeric name.

pub fn label(self) -> Cow<'static, str>

English label for logs and non-localized contexts. An uncataloged control is named by number — Control 0x01f3, deliberately not the control:0x01f3 config form, so a label pasted into config.toml fails to parse instead of half-working.

pub fn translation_key(self) -> &'static str

Stable catalog key for the localized label. An uncataloged control resolves to UNKNOWN_CONTROL_TRANSLATION_KEY, the plain word “Control”; callers that show the number append Cid::hex.

pub fn hex(self) -> String

The control ID as 0x01f3, for labels of uncataloged controls.

Trait Implementations

impl Clone for Cid

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Cid

impl Debug for Cid

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

Formats the value using the given formatter.

impl Display for Cid

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

Formats the value using the given formatter.

impl Eq for Cid

impl Hash for Cid

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 Cid

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

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl PartialEq for Cid

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Cid

fn partial_cmp(&self, other: &Self) -> 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 Cid