Struct Registration 

pub struct Registration<'a, F: ForLt + 'static> { /* private fields */ }

The registration of an auxiliary device.

This type represents the registration of a [struct auxiliary_device]. When its parent device is unbound, the corresponding auxiliary device will be unregistered from the system.

The type parameter F is a ForLt encoding of the registration data type. For non-lifetime-parameterized types, use ForLt!(T). The data can be accessed by the auxiliary driver through Device::registration_data().

Invariants

self.adev always holds a valid pointer to an initialized and registered [struct auxiliary_device] whose registration_data_rust field points to a valid Pin<KBox<RegistrationData<F::Of<'static>>>>.

Implementations

impl<'a, F: ForLt> Registration<'a, F>

where for<'b> F::Of<'b>: Send + Sync,

pub unsafe fn new_with_lt<E>( parent: &'a Device<Bound>, name: &CStr, id: u32, modname: &CStr, data: impl PinInit<F::Of<'a>, E>, ) -> Result<Self>

where Error: From<E>,

Create and register a new auxiliary device with the given registration data.

The data is owned by the registration and can be accessed through the auxiliary device via Device::registration_data().

Safety

The caller must not mem::forget() the returned Registration or otherwise prevent its Drop implementation from running, since the registration data may contain borrowed references that become invalid after 'a ends.

If the registration data is 'static, use the safe Registration::new() instead.

pub fn new<E>( parent: &'a Device<Bound>, name: &CStr, id: u32, modname: &CStr, data: impl PinInit<F::Of<'a>, E>, ) -> Result<Self>

where F::Of<'a>: 'static, Error: From<E>,

Create and register a new auxiliary device with 'static registration data.

Safe variant of Registration::new_with_lt() for registration data that does not contain borrowed references.

Trait Implementations

impl<F: ForLt> Drop for Registration<'_, F>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

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

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl<F: ForLt> Send for Registration<'_, F>

where for<'a> F::Of<'a>: Send,

impl<F: ForLt> Sync for Registration<'_, F>

where for<'a> F::Of<'a>: Send,