Struct ProximityComponent

pub struct ProximityComponent<P: ProximityDriver<'static> + 'static> { /* private fields */ }

Implementations

impl<P: ProximityDriver<'static>> ProximityComponent<P>

pub fn new( sensor: &'static P, board_kernel: &'static Kernel, driver_num: usize, ) -> ProximityComponent<P>

Trait Implementations

impl<P: ProximityDriver<'static>> Component for ProximityComponent<P>

type StaticInput = &'static mut MaybeUninit<ProximitySensor<'static>>

An optional type to specify the chip or board specific static memory that a component needs to setup the output object(s). This is the memory that crate::static_buf!() would normally setup, but generic components cannot setup static buffers for types which are chip-dependent, so those buffers have to be passed in manually, and the Component::StaticInput type makes this possible.

type Output = &'static ProximitySensor<'static>

The type (e.g., capsule, peripheral) that this implementation of Component produces via Component::finalize(). This is typically a static reference (&'static).

fn finalize(self, s: Self::StaticInput) -> Self::Output

A factory method that returns an instance of the Output type of this Component implementation. This is used in the boot sequence to instantiate and initialize part of the Tock kernel. This factory method may only be called once per Component instance.