Struct PeripheralRef

Source
pub struct PeripheralRef<'a, T> { /* private fields */ }
Expand description

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 GpioPin<5> or SPI2) 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. PeripheralRef stores a copy of T instead, so it’s the same size.
  • Code size efficiency. If the user uses the same driver with both SPI2 and &mut SPI2, the driver code would be monomorphized two times. With PeripheralRef, the driver is generic over a lifetime only. SPI2 becomes PeripheralRef<'static, SPI2>, and &mut SPI2 becomes PeripheralRef<'a, SPI2>. Lifetimes don’t cause monomorphization.

Implementations§

Source§

impl<'a, T> PeripheralRef<'a, T>

Source

pub fn new(inner: T) -> Self

Create a new exclusive reference to a peripheral

Source

pub unsafe fn clone_unchecked(&self) -> PeripheralRef<'a, T>
where T: Peripheral<P = 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 PeripheralRef that borrows self, which allows the borrow checker to enforce this at compile time.

Source

pub fn reborrow(&mut self) -> PeripheralRef<'_, T>
where T: Peripheral<P = T>,

Reborrow into a “child” PeripheralRef.

self will stay borrowed until the child PeripheralRef is dropped.

Source

pub fn map<U>(self, transform: impl FnOnce(T) -> U) -> PeripheralRef<'a, U>

Transform the inner peripheral.

This converts from PeripheralRef<'a, T> to PeripheralRef<'a, U>, using a user-provided impl to convert from T to U.

Source

pub fn map_into<U>(self) -> PeripheralRef<'a, U>
where T: Into<U>,

Map the inner peripheral using Into.

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

For example, this can be useful to degrade GPIO pins: converting from PeripheralRef<'a, GpioPin<11>> to PeripheralRef<'a, AnyPin>.

Trait Implementations§

Source§

impl<'a, T: Debug> Debug for PeripheralRef<'a, T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T> Deref for PeripheralRef<'_, T>

Source§

type Target = T

The resulting type after dereferencing.
Source§

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

Dereferences the value.
Source§

impl<'a, T> Format for PeripheralRef<'a, T>
where T: Format, PhantomData<&'a mut T>: Format,

Source§

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

Writes the defmt representation of self to fmt.
Source§

impl<T: Peripheral> Peripheral for PeripheralRef<'_, T>

Source§

type P = <T as Peripheral>::P

Peripheral singleton type
Source§

unsafe fn clone_unchecked(&self) -> Self::P

Unsafely clone (duplicate) a peripheral singleton. Read more
Source§

fn into_ref<'a>(self) -> PeripheralRef<'a, Self::P>
where Self: 'a,

Convert a value into a PeripheralRef. Read more
Source§

fn map_into<U>(self) -> U
where Self::P: Into<U>, U: Peripheral<P = U>,

Map the peripheral using Into. Read more
Source§

fn map<U>(self, transform: impl FnOnce(Self::P) -> U) -> U
where U: Peripheral<P = U>,

Map the peripheral using Into. Read more

Auto Trait Implementations§

§

impl<'a, T> Freeze for PeripheralRef<'a, T>
where T: Freeze,

§

impl<'a, T> RefUnwindSafe for PeripheralRef<'a, T>
where T: RefUnwindSafe,

§

impl<'a, T> Send for PeripheralRef<'a, T>
where T: Send,

§

impl<'a, T> Sync for PeripheralRef<'a, T>
where T: Sync,

§

impl<'a, T> Unpin for PeripheralRef<'a, T>
where T: Unpin,

§

impl<'a, T> !UnwindSafe for PeripheralRef<'a, T>

Blanket Implementations§

§

impl<T> Any for T
where T: 'static + ?Sized,

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> Borrow<T> for T
where T: ?Sized,

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

impl<T> BorrowMut<T> for T
where T: ?Sized,

§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T, U> Into<U> for T
where U: From<T>,

§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of [From]<T> for U chooses to do.

§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.