Struct FlexLed 

pub struct FlexLed<P> { /* private fields */ }

LED with runtime-determined polarity.

Unlike Led which bakes polarity into the type, FlexLed stores it as a PolarityMode value. Useful when the polarity is read from configuration at runtime rather than known at compile time. Each operation incurs one extra match vs Led — negligible on Cortex-M.

Examples

use status_led::{FlexLed, PolarityMode};

let pol = if config.active_low {
    PolarityMode::ActiveLow
} else {
    PolarityMode::ActiveHigh
};
let mut led = FlexLed::new(pin, pol).unwrap();
led.on().unwrap();

Implementations

impl<P> FlexLed<P>

pub fn from_pin(pin: P, polarity: PolarityMode) -> Self

Build from an already-configured pin without changing its level.

impl<P: OutputPin> FlexLed<P>

pub fn new(pin: P, polarity: PolarityMode) -> Result<Self, P::Error>

Build and force the pin to the logical OFF state.

pub fn on(&mut self) -> Result<(), P::Error>

Turn the LED on.

pub fn off(&mut self) -> Result<(), P::Error>

Turn the LED off.

pub fn set(&mut self, state: bool) -> Result<(), P::Error>

Set the logical state: true = ON, false = OFF.

impl<P: StatefulOutputPin> FlexLed<P>

pub fn is_on(&mut self) -> Result<bool, P::Error>

Read the logical state from the hardware register.

pub fn is_off(&mut self) -> Result<bool, P::Error>

Inverse of is_on.

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

Toggle the logical state.

impl<P> FlexLed<P>

pub fn polarity(&self) -> PolarityMode

Return the current polarity.

pub fn release(self) -> P

Consume the FlexLed and return the underlying pin.

Trait Implementations

impl<P, POL: Polarity> From<Led<P, POL>> for FlexLed<P>

fn from(led: Led<P, POL>) -> Self

Converts to this type from the input type.