Skip to main content

Receiver

Struct Receiver 

Source
pub struct Receiver { /* private fields */ }
Expand description

Implements the Unifying wireless receiver.

Implementations§

Source§

impl Receiver

Source

pub fn new(chan: Arc<HidppChannel>) -> Result<Self, ReceiverError>

Tries to initialize a new Receiver from a raw HID++ channel.

Returns ReceiverError::UnknownReceiver when the channel’s VID/PID doesn’t match any known Unifying receiver.

Source

pub fn listen(&self) -> Receiver<Event>

Creates a new listener for receiving receiver events.

Source

pub async fn count_pairings(&self) -> Result<u8, ReceiverError>

Counts the number of devices currently paired to this receiver. Offline (sleeping) devices are included since pairings are persistent.

Source

pub async fn set_wireless_notifications( &self, enabled: bool, ) -> Result<(), ReceiverError>

Enables or disables wireless device-connection notifications.

The receiver only re-broadcasts 0x41 device-arrival events (the source for Self::trigger_device_arrival) while this is on. With it off the trigger write is ACK’d but emits nothing — which is why a paired, online device can fail to enumerate. Solaar enables this before listing.

Read-modify-write of just the WIRELESS bit so it can’t clobber other flags already set on register 0x00 — notably SOFTWARE_PRESENT (0x08), which the pairing flow enables (pairing.rs writes [0x00, 0x09, 0x00]) and a concurrent inventory poll would otherwise drop.

Source

pub async fn trigger_device_arrival(&self) -> Result<(), ReceiverError>

Triggers device-arrival notifications for all currently connected devices. Used to enumerate online devices at startup.

Source

pub async fn get_receiver_info(&self) -> Result<ReceiverInfo, ReceiverError>

Provides general information about the receiver (serial number and pairing slot count).

Source

pub async fn get_device_pairing_information( &self, device_index: u8, ) -> Result<DevicePairingInformation, ReceiverError>

Retrieves the pairing information for the device at device_index (1-based slot number).

Source

pub async fn get_unique_id(&self) -> Result<String, ReceiverError>

Provides the unique ID of the receiver (serial number).

Trait Implementations§

Source§

impl Clone for Receiver

Source§

fn clone(&self) -> Receiver

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

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

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
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V