Struct Led 

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

Monochrome LED with polarity chosen at construction time.

Stores a PolarityMode value — each operation incurs one match which is negligible on Cortex-M.

No internal state cache — is_on() reads the hardware register (ODR) directly and applies the polarity conversion. In the embassy ecosystem OutputPin::Error is Infallible, so unwrapping results is safe.

Examples

use status_led::{Led, PolarityMode};

let mut led = Led::new(pin, PolarityMode::ActiveLow).unwrap();
led.on().unwrap();
led.toggle().unwrap();
assert!(led.is_on().unwrap());

Implementations

impl<P> Led<P>

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

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

Prefer this when the HAL already set the pin to a known state (e.g. Output::new(pin, Level::High, Speed::Low) for an active-low LED).

impl<P: OutputPin> Led<P>

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

Build and force the pin to the logical OFF state.

Safest default — guarantees the LED starts dark regardless of the pin’s reset state.

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

Turn the LED on (logical ON → physical level determined by polarity).

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

Turn the LED off (logical OFF → physical level determined by polarity).

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

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

impl<P: StatefulOutputPin> Led<P>

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

Read the logical state from the hardware register.

Reads the physical pin level (ODR register on STM32), then converts through the polarity. Requires &mut self because StatefulOutputPin::is_set_high does — in practice the read is a single register access with no side effects.

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.

Delegates to StatefulOutputPin::toggle. On embassy this is a single bit-band operation (ODR ^= 1 << n) — unconditionally flips the physical pin, which is always correct regardless of polarity.

impl<P> Led<P>

pub fn polarity(&self) -> PolarityMode

Return the current polarity.

pub fn release(self) -> P

Consume the Led and return the underlying pin.

Trait Implementations

impl<P> Debug for Led<P>

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

Formats the value using the given formatter.