Struct embedded_hal_sync_pins::pins::InputPin

pub struct InputPin { /* fields omitted */ }

A mutable input pin that can be safely shared between threads.

This pin implements embedded_hal::InputPin and can be used to share an AtomicPinState with an embedded_hal implementation.

Examples

use embedded_hal_sync_pins::pins::{AtomicPinState, InputPin, PinState};
use embedded_hal::digital::InputPin as HalInputPin;
use std::sync::{Arc, atomic::Ordering};

let state = Arc::new(AtomicPinState::new_with_state(PinState::Low));
let pin = InputPin::new(state.clone());
assert_eq!(Ok(true), pin.try_is_low());
state.store(PinState::High, Ordering::SeqCst);
assert_eq!(Ok(true), pin.try_is_high());

Implementations

impl InputPin

pub fn new(state: Arc<AtomicPinState>) -> Self

Creates a new input pin with a given PinState.

Trait Implementations

impl Clone for InputPin

fn clone(&self) -> InputPin

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for InputPin

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

Formats the value using the given formatter.

impl InputPin for InputPin

type Error = Infallible

Error type

fn try_is_high(&self) -> Result<bool, Self::Error>

Is the input pin high?

fn try_is_low(&self) -> Result<bool, Self::Error>

Is the input pin low?