Struct DeviceContext

pub struct DeviceContext<S>
where
    S: DeviceState,
{ /* private fields */ }

Handle for accessing a DeviceState associated with a specific device.

Implementations

impl<S> DeviceContext<S>

where S: DeviceState,

pub fn locate<D>(device: &D) -> DeviceContext<S>

where D: Device + 'static,

Creates a DeviceState handle for the given device.

Registers the device-type combination globally if needed.

pub fn insert<D>(device: &D, state_new: S) -> Result<DeviceContext<S>, String>

where D: Device + 'static,

Inserts a new state associated with the device.

Returns

An error if the device already has a registered state.

pub fn lock_device(&self) -> DeviceGuard<'_>

Locks the current device making sure this device can be used.

pub fn lock(&self) -> DeviceStateGuard<'_, S>

Acquires exclusive mutable access to the DeviceState.

The same device can lock multiple types at the same time.

Panics

If the same state type is locked multiple times on the same thread. This can only happen with recursive locking of the same state, which isn’t allowed since having multiple mutable references to the same state isn’t valid.

Trait Implementations

impl<S> Clone for DeviceContext<S>

where S: DeviceState,

fn clone(&self) -> DeviceContext<S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S> Sync for DeviceContext<S>

where S: DeviceState,

There is nothing to read without a lock, and it’s fine to allow locking a context reference.