Struct Device 

pub struct Device<Ctx: DeviceContext = Normal>(/* private fields */);

The auxiliary device representation.

This structure represents the Rust abstraction for a C struct auxiliary_device. The implementation abstracts the usage of an already existing C struct auxiliary_device within Rust code that we get passed from the C side.

Invariants

A Device instance represents a valid struct auxiliary_device created by the C portion of the kernel.

Implementations

impl<Ctx: DeviceContext> Device<Ctx>

pub fn id(&self) -> u32

Returns the auxiliary device’ id.

impl Device<Bound>

pub fn parent(&self) -> &Device<Bound>

Returns a bound reference to the parent device::Device.

pub fn registration_data_with<F: ForLt + 'static, R>( &self, f: impl for<'a> FnOnce(Pin<&'a F::Of<'a>>) -> R, ) -> Result<R>

Access the registration data set by the registering (parent) driver through a closure.

F is the ForLt encoding of the data type. The closure receives a pinned reference to the registration data.

For covariant types that implement CovariantForLt, prefer registration_data which returns a direct reference.

Returns EINVAL if F does not match the type used by the parent driver when calling Registration::new().

Returns ENOENT if no registration data has been set, e.g. when the device was registered by a C driver.

pub fn registration_data<F: CovariantForLt + 'static>( &self, ) -> Result<Pin<&F::Of<'_>>>

Returns a pinned reference to the registration data set by the registering (parent) driver.

This method is only available when F implements CovariantForLt, which guarantees that the lifetime shortening is sound.

For non-covariant types, use the closure-based Self::registration_data_with.

Returns EINVAL if F does not match the type used by the parent driver when calling Registration::new().

Returns ENOENT if no registration data has been set, e.g. when the device was registered by a C driver.

impl Device

pub fn parent(&self) -> &Device

Returns a reference to the parent device::Device.

Trait Implementations

impl AlwaysRefCounted for Device

fn inc_ref(&self)

Increments the reference count on the object.

unsafe fn dec_ref(obj: NonNull<Self>)

Decrements the reference count on the object.

impl<Ctx: DeviceContext> AsBusDevice<Ctx> for Device<Ctx>

const OFFSET: usize

The relative offset to the device field.

unsafe fn from_device(dev: &Device<Ctx>) -> &Self

where Self: Sized,

Convert a reference to Device into Self.

impl<Ctx: DeviceContext> AsRef<Device<Ctx>> for Device<Ctx>

fn as_ref(&self) -> &Device<Ctx>

Converts this type into a shared reference of the (usually inferred) input type.

impl<'a> Deref for Device<CoreInternal<'a>>

type Target = Device<Core<'a>>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a> Deref for Device<Core<'a>>

type Target = Device<Bound>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Deref for Device<BoundInternal>

type Target = Device<Bound>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Deref for Device<Bound>

type Target = Device

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl From<&Device<Bound>> for ARef<Device>

fn from(dev: &Device<Bound>) -> Self

Converts to this type from the input type.

impl From<&Device<BoundInternal>> for ARef<Device>

fn from(dev: &Device<BoundInternal>) -> Self

Converts to this type from the input type.

impl<'a> From<&Device<Core<'a>>> for ARef<Device>

fn from(dev: &Device<Core<'a>>) -> Self

Converts to this type from the input type.

impl<'a> From<&Device<CoreInternal<'a>>> for ARef<Device>

fn from(dev: &Device<CoreInternal<'a>>) -> Self

Converts to this type from the input type.

impl Send for Device

impl Sync for Device

impl Sync for Device<Bound>