Struct LED

pub struct LED<const I: u8>(());

The Ith LED (calling the LED<I>_{ON,OFF,TOGGLE} macros).

The preferred interface for turning a LED on and off is switch_hal::OutputSwitch.

LEDs are accessible safely; any not implemented on a board are silently ignored.

Tuple Fields

0: ()

Implementations

impl<const I: u8> LED<I>

pub const fn new() -> Self

👎Deprecated since 0.9.1: Use new_unchecked() to retain the behavior this function has always had; future versions of .new() will panic when used with a board that does not have that LED.

pub const fn new_unchecked() -> Self

Accesses the LED numbered I as LED::<I>::new_unchecked().

It is not an error if this board does not have a LED with that number; the resulting struct will be available but its methods have no effect.

pub const fn new_checked() -> Result<Self, LedNotPresent>

Accesses the LED numbered I as LED::<I>::new_checked()?.

An LED is returned if present on the board, which is known at build time.

const fn is_present() -> bool

Trait Implementations

impl<const I: u8> Debug for LED<I>

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

Formats the value using the given formatter.

impl<const I: u8> OutputSwitch for LED<I>

type Error = Infallible

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

Turns the switch on

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

Turns the switch off

impl<const I: u8> ToggleableOutputSwitch for LED<I>

type Error = Infallible

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

Toggles the current state of the OutputSwitch

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 0 bytes