Struct embedded_hal_sync_pins::pins::AtomicPinState

pub struct AtomicPinState { /* fields omitted */ }

A digital pin state which can be safely shared between threads.

This type is based on AtomicUsize, so the same limitations and platform support apply.

Implementations

impl AtomicPinState

pub fn new() -> Self

Creates a new atomic pin state with a floating state.

pub fn new_with_state(state: PinState) -> Self

Creates a new atomic pin state with a given state.

Examples

use embedded_hal_sync_pins::pins::{PinState, AtomicPinState};

let high = AtomicPinState::new_with_state(PinState::High);
let low = AtomicPinState::new_with_state(PinState::Low);

pub fn load(&self, order: Ordering) -> PinState

Loads a state from the atomic pin state.

load takes an Ordering argument which describes the memory ordering of this operation. For more information see AtomicUsize::load.

pub fn store(&self, state: PinState, order: Ordering)

Stores a state into the atomic pin state.

store takes an Ordering argument which describes the memory ordering of this operation. For more information see AtomicUsize::store.

pub fn fetch_update<F>(&self, set_order: Ordering, fetch_order: Ordering, f: F) where
    F: FnMut(PinState) -> Option<PinState>, 

Updates the state of this atomic pin state based on a stored value.

toggle takes an Ordering argument which describes the memory ordering of this operation. For more information see AtomicUsize::store.

Trait Implementations

impl Debug for AtomicPinState

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

Formats the value using the given formatter.

impl Default for AtomicPinState

fn default() -> Self

Returns the “default value” for a type.