Struct Peri

pub struct Peri<'a, T>
where
    T: PeripheralType,
{ /* private fields */ }

An exclusive reference to a peripheral.

This is functionally the same as a &'a mut T. There’s a few advantages in having a dedicated struct instead:

• Memory efficiency: Peripheral singletons are typically either zero-sized (for concrete peripherals like PA9 or SPI4) or very small (for example AnyPin, which is 1 byte). However &mut T is always 4 bytes for 32-bit targets, even if T is zero-sized. Peripheral stores a copy of T instead, so it’s the same size.
• Code size efficiency. If the user uses the same driver with both SPI4 and &mut SPI4, the driver code would be monomorphized two times. With Peri, the driver is generic over a lifetime only. SPI4 becomes Peri<'static, SPI4>, and &mut SPI4 becomes Peri<'a, SPI4>. Lifetimes don’t cause monomorphization.

Implementations

impl<'a, T> Peri<'a, T>

where T: PeripheralType,

pub unsafe fn clone_unchecked(&self) -> Peri<'a, T>

Unsafely clone (duplicate) a peripheral singleton.

Safety

This returns an owned clone of the peripheral. You must manually ensure only one copy of the peripheral is in use at a time. For example, don’t create two SPI drivers on SPI1, because they will “fight” each other.

You should strongly prefer using reborrow() instead. It returns a Peri that borrows self, which allows the borrow checker to enforce this at compile time.

pub fn reborrow(&mut self) -> Peri<'_, T>

Reborrow into a “child” Peri.

self will stay borrowed until the child Peripheral is dropped.

pub fn into<U>(self) -> Peri<'a, U>

where T: Into<U>, U: PeripheralType,

Map the inner peripheral using Into.

This converts from Peri<'a, T> to Peri<'a, U>, using an Into impl to convert from T to U.

For example, this can be useful to.into() GPIO pins: converting from Peri<’a, PB11>toPeri<’a, AnyPin>`.

Trait Implementations

impl<'a, T> Debug for Peri<'a, T>

where T: Debug + PeripheralType,

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'a, T> Deref for Peri<'a, T>

where T: PeripheralType,

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &<Peri<'a, T> as Deref>::Target

Dereferences the value.

impl<'a, T> Format for Peri<'a, T>

where T: PeripheralType + Format, PhantomData<&'a mut T>: Format,

fn format(&self, f: Formatter<'_>)

Writes the defmt representation of self to fmt.

impl Input for Peri<'_, P0_13>

fn degrade_saadc<'a>(self) -> AnyInput<'a>

where Self: 'a,

Convert this SAADC input to a type-erased AnyInput.

impl Input for Peri<'_, P0_14>

fn degrade_saadc<'a>(self) -> AnyInput<'a>

where Self: 'a,

Convert this SAADC input to a type-erased AnyInput.

impl Input for Peri<'_, P0_15>

fn degrade_saadc<'a>(self) -> AnyInput<'a>

where Self: 'a,

Convert this SAADC input to a type-erased AnyInput.

impl Input for Peri<'_, P0_16>

fn degrade_saadc<'a>(self) -> AnyInput<'a>

where Self: 'a,

Convert this SAADC input to a type-erased AnyInput.

impl Input for Peri<'_, P0_17>

fn degrade_saadc<'a>(self) -> AnyInput<'a>

where Self: 'a,

Convert this SAADC input to a type-erased AnyInput.

impl Input for Peri<'_, P0_18>

fn degrade_saadc<'a>(self) -> AnyInput<'a>

where Self: 'a,

Convert this SAADC input to a type-erased AnyInput.

impl Input for Peri<'_, P0_19>

fn degrade_saadc<'a>(self) -> AnyInput<'a>

where Self: 'a,

Convert this SAADC input to a type-erased AnyInput.

impl Input for Peri<'_, P0_20>

fn degrade_saadc<'a>(self) -> AnyInput<'a>

where Self: 'a,

Convert this SAADC input to a type-erased AnyInput.