Struct embassy_stm32::gpio::Flex

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

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§

source§

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

source

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.

source

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.

source

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

Put the pin into input mode.

source

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.

source

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.

source

pub fn is_high(&self) -> bool

Get whether the pin input level is high.

source

pub fn is_low(&self) -> bool

Get whether the pin input level is low.

source

pub fn get_level(&self) -> Level

Get the current pin input level.

source

pub fn is_set_high(&self) -> bool

Get whether the output level is set to high.

source

pub fn is_set_low(&self) -> bool

Get whether the output level is set to low.

source

pub fn get_output_level(&self) -> Level

Get the current output level.

source

pub fn set_high(&mut self)

Set the output as high.

source

pub fn set_low(&mut self)

Set the output as low.

source

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

Set the output level.

source

pub fn toggle(&mut self)

Toggle the output level.

Trait Implementations§

source§

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

source§

fn drop(&mut self)

Executes the destructor for this type. Read more
source§

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

§

type Error = Infallible

Error type
source§

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

§

type Error = Infallible

Error type
source§

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

Is the input pin high?
source§

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

Is the input pin low?
source§

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

source§

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

Is the input pin high?
source§

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

Is the input pin low?
source§

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

source§

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

Drives the pin high. Read more
source§

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

Drives the pin low. Read more
source§

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

Drives the pin high or low depending on the provided value. Read more
source§

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

§

type Error = Infallible

Error type
source§

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

Drives the pin high Read more
source§

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

Drives the pin low Read more
source§

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

Drives the pin high or low depending on the provided value Read more
source§

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

source§

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

Is the output pin set as low?

source§

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

Is the pin in drive high mode? Read more
source§

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

source§

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

Is the output pin set as low?

source§

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

Is the pin in drive high mode? Read more
source§

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

Toggle pin output.
source§

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

§

type Error = Infallible

Error type
source§

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

Toggle pin output.

Auto Trait Implementations§

§

impl<'d, T> Freeze for Flex<'d, T>
where T: Freeze,

§

impl<'d, T> RefUnwindSafe for Flex<'d, T>
where T: RefUnwindSafe,

§

impl<'d, T> Send for Flex<'d, T>
where T: Send,

§

impl<'d, T> Sync for Flex<'d, T>
where T: Sync,

§

impl<'d, T> Unpin for Flex<'d, T>
where T: Unpin,

§

impl<'d, T> !UnwindSafe for Flex<'d, T>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.