Struct PartiallyErasedPin

pub struct PartiallyErasedPin<const P: char, MODE> { /* private fields */ }

Partially erased pin

• MODE is one of the pin modes (see Modes section).
• P is port name: A for GPIOA, B for GPIOB, etc.

Implementations

impl<const P: char, MODE: PinMode> PartiallyErasedPin<P, MODE>

pub fn into_mode<M: PinMode>(self) -> PartiallyErasedPin<P, M>

Converts pin into specified mode

impl<const P: char, MODE> PartiallyErasedPin<P, MODE>

pub fn restore<const N: u8>(self) -> Pin<P, N, MODE>

Convert partially type erased pin to Pin with fixed type

impl<const P: char, MODE> PartiallyErasedPin<P, Output<MODE>>

pub fn set_high(&mut self)

Drives the pin high

pub fn set_low(&mut self)

Drives the pin low

pub fn get_state(&self) -> PinState

Is the pin in drive high or low mode?

pub fn set_state(&mut self, state: PinState)

Drives the pin high or low depending on the provided value

pub fn is_set_high(&self) -> bool

Is the pin in drive high mode?

pub fn is_set_low(&self) -> bool

Is the pin in drive low mode?

pub fn toggle(&mut self)

Toggle pin output

impl<const P: char, MODE> PartiallyErasedPin<P, MODE>

where MODE: Readable,

pub fn is_high(&self) -> bool

Is the input pin high?

pub fn is_low(&self) -> bool

Is the input pin low?

Trait Implementations

impl<const P: char, MODE> Debug for PartiallyErasedPin<P, MODE>

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

Formats the value using the given formatter.

impl<const P: char, MODE> ErrorType for PartiallyErasedPin<P, MODE>

type Error = Infallible

Error type

impl<const P: char, MODE> Format for PartiallyErasedPin<P, MODE>

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

Writes the defmt representation of self to fmt.

impl<const P: char, MODE> From<PartiallyErasedPin<P, MODE>> for ErasedPin<MODE>

fn from(p: PartiallyErasedPin<P, MODE>) -> Self

Partially erased pin-to-erased pin conversion using the From trait.

Note that From is the reciprocal of Into.

impl<const P: char, const N: u8, MODE> From<Pin<P, N, MODE>> for PartiallyErasedPin<P, MODE>

fn from(p: Pin<P, N, MODE>) -> Self

Pin-to-partially erased pin conversion using the From trait.

Note that From is the reciprocal of Into.

impl<const P: char, MODE> InputPin for PartiallyErasedPin<P, MODE>

where MODE: Readable,

type Error = Infallible

Error type

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

Is the input pin high?

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

Is the input pin low?

impl<const P: char, MODE> InputPin for PartiallyErasedPin<P, MODE>

where MODE: Readable,

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

Is the input pin high?

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

Is the input pin low?

impl<const P: char, MODE> OutputPin for PartiallyErasedPin<P, Output<MODE>>

type Error = Infallible

Error type

fn set_high(&mut self) -> Result<(), Self::Error>

Drives the pin high

fn set_low(&mut self) -> Result<(), Self::Error>

Drives the pin low

fn set_state(&mut self, state: PinState) -> Result<(), Self::Error>

Drives the pin high or low depending on the provided value

impl<const P: char, MODE> OutputPin for PartiallyErasedPin<P, Output<MODE>>

fn set_high(&mut self) -> Result<(), Self::Error>

Drives the pin high.

fn set_low(&mut self) -> Result<(), Self::Error>

Drives the pin low.

fn set_state(&mut self, state: PinState) -> Result<(), Self::Error>

Drives the pin high or low depending on the provided value.

impl<const P: char, MODE> PinExt for PartiallyErasedPin<P, MODE>

type Mode = MODE

Current pin mode

fn pin_id(&self) -> u8

Pin number

fn port_id(&self) -> u8

Port number starting from 0

impl<const P: char, MODE> StatefulOutputPin for PartiallyErasedPin<P, Output<MODE>>

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

Is the pin in drive high mode?

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

Is the pin in drive low mode?

impl<const P: char, MODE> StatefulOutputPin for PartiallyErasedPin<P, Output<MODE>>

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

Is the pin in drive high mode?

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

Is the pin in drive low mode?

fn toggle(&mut self) -> Result<(), Self::Error>

Toggle pin output.

impl<const P: char, MODE> ToggleableOutputPin for PartiallyErasedPin<P, Output<MODE>>

type Error = Infallible

Error type

fn toggle(&mut self) -> Result<(), Self::Error>

Toggle pin output.