Struct DynamicPeripherals

pub struct DynamicPeripherals { /* private fields */ }

Runtime-enforced Singleton Peripheral Access

A flexible alternative to the statically checked Peripherals, that instead verifies singleton access to ports and peripherals at runtime, allowing you to move this struct around after taking a port or device.

This is useful in cases where:

• You want to store unclaimed peripherals after claiming something, or pass this struct by value after taking something from it (Peripherals prevents this due to partial-move rules).
• Port assignments need to be configurable without recompiling.
• Port numbers need to be determined programmatically.

The system still ensures only one device can use a port at a time, but handles the bookkeeping at runtime rather than compile time. This trades a small performance cost for increased flexibility, but is generally preferable to use the static Peripherals struct at runtime.

Implementations

impl DynamicPeripherals

pub fn new(peripherals: Peripherals) -> Self

Creates a new dynamic peripherals

In order to guarantee that no new ports are created by this struct, this function requires a pre-existing Peripherals instance.

This guarantees safety because Peripherals cannot be passed by value after it has been used to create devices.

pub const fn take_smart_port(&mut self, port_number: u8) -> Option<SmartPort>

Creates a SmartPort only if one has not been created on the given port before.

Panics

This function panics if the provided port is outside the range 1-21. Ports outside of this range are invalid and cannot be created.

pub const fn return_smart_port(&mut self, port: SmartPort)

Returns a SmartPort to the dynamic peripherals.

Panics

This function panics if the provided port is outside the range 1-21.

pub const fn take_adi_port(&mut self, port_number: u8) -> Option<AdiPort>

Creates an AdiPort only if one has not been created on the given slot before.

Panics

This function panics if the provided port is outside the range 1-8. Slots outside of this range are invalid and cannot be created.

pub const fn return_adi_port(&mut self, port: AdiPort)

Returns an AdiPort to the dynamic peripherals.

Panics

This function panics if the provided port is outside the range 1-8.

pub const fn take_display(&mut self) -> Option<Display>

Creates a Display only if one has not been created before.

pub fn return_display(&mut self, display: Display)

Returns a Display to the dynamic peripherals.

pub const fn take_primary_controller(&mut self) -> Option<Controller>

Creates a primary controller only if one has not been created before.

pub const fn return_primary_controller(&mut self, controller: Controller)

Returns the primary controller to the dynamic peripherals.

pub const fn take_partner_controller(&mut self) -> Option<Controller>

Creates a partner controller only if one has not been created before.

pub const fn return_partner_controller(&mut self, controller: Controller)

Returns the partner controller to the dynamic peripherals.

Trait Implementations

impl Debug for DynamicPeripherals

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

Formats the value using the given formatter.

impl From<Peripherals> for DynamicPeripherals

fn from(peripherals: Peripherals) -> Self

Converts to this type from the input type.