Struct embassy_stm32::gpio::Flex

pub struct Flex<'d, T: Pin> { /* private fields */ }

GPIO flexible pin.

This pin can either be a disconnected, input, or output pin, or both. The level register bit will remain set while not in output mode, so the pin’s level will be ‘remembered’ when it is not in output mode.

Implementations

impl<'d, T: Pin> Flex<'d, T>

pub fn new(pin: impl Peripheral<P = T> + 'd) -> Self

Wrap the pin in a Flex.

The pin remains disconnected. The initial output level is unspecified, but can be changed before the pin is put into output mode.

pub fn degrade(self) -> Flex<'d, AnyPin>

Type-erase (degrade) this pin into an AnyPin.

This converts pin singletons (PA5, PB6, …), which are all different types, into the same type. It is useful for creating arrays of pins, or avoiding generics.

pub fn set_as_input(&mut self, pull: Pull)

Put the pin into input mode.

pub fn set_as_output(&mut self, speed: Speed)

Put the pin into output mode.

The pin level will be whatever was set before (or low by default). If you want it to begin at a specific level, call set_high/set_low on the pin first.

pub fn set_as_input_output(&mut self, speed: Speed, pull: Pull)

Put the pin into input + output mode.

This is commonly used for “open drain” mode. the hardware will drive the line low if you set it to low, and will leave it floating if you set it to high, in which case you can read the input to figure out whether another device is driving the line low.

The pin level will be whatever was set before (or low by default). If you want it to begin at a specific level, call set_high/set_low on the pin first.

pub fn is_high(&self) -> bool

Get whether the pin input level is high.

pub fn is_low(&self) -> bool

Get whether the pin input level is low.

pub fn get_level(&self) -> Level

Get the current pin input level.

pub fn is_set_high(&self) -> bool

Get whether the output level is set to high.

pub fn is_set_low(&self) -> bool

Get whether the output level is set to low.

pub fn get_output_level(&self) -> Level

Get the current output level.

pub fn set_high(&mut self)

Set the output as high.

pub fn set_low(&mut self)

Set the output as low.

pub fn set_level(&mut self, level: Level)

Set the output level.

pub fn toggle(&mut self)

Toggle the output level.

Trait Implementations

impl<'d, T: Pin> Drop for Flex<'d, T>

fn drop(&mut self)

Executes the destructor for this type.

impl<'d, T: Pin> ErrorType for Flex<'d, T>

type Error = Infallible

Error type

impl<'d, T: Pin> InputPin for Flex<'d, T>

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<'d, T: Pin> InputPin for Flex<'d, T>

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<'d, T: Pin> OutputPin for Flex<'d, T>

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<'d, T: Pin> OutputPin for Flex<'d, T>

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<'d, T: Pin> StatefulOutputPin for Flex<'d, T>

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

Is the output pin set as low?

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

Is the pin in drive high mode?

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

Toggle pin output.

impl<'d, T: Pin> StatefulOutputPin for Flex<'d, T>

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

Is the output pin set as low?

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

Is the pin in drive high mode?

impl<'d, T: Pin> ToggleableOutputPin for Flex<'d, T>

type Error = Infallible

Error type

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

Toggle pin output.