Enum Polarity 

pub enum Polarity {
    ActiveHigh,
    ActiveLow,
}

Whether a signal is asserted by a high or a low physical level.

Active-low wiring is everywhere in cheap hardware: a button to ground with a pull-up reads Level::Low when pressed, and many relay boards energise when their input is driven low. This type maps between the logical idea of “asserted” and the physical Level so the mapping lives in one place instead of in scattered inversions.

Examples

use pamoja_gpio::pin::{Level, Polarity};

// An active-low relay: asserting it (switching the relay on) drives the pin low.
let relay = Polarity::ActiveLow;
assert_eq!(relay.level(true), Level::Low);
assert_eq!(relay.level(false), Level::High);
assert!(relay.is_asserted(Level::Low));

Variants

ActiveHigh

A high level means asserted (the direct mapping).

ActiveLow

A low level means asserted (the inverted mapping).

Implementations

impl Polarity

pub fn level(self, asserted: bool) -> Level

Returns the physical level for a logical state.

Arguments

• asserted - whether the signal should be asserted.

Returns

The Level that represents that state under this polarity.

pub fn is_asserted(self, level: Level) -> bool

Returns whether a physical level means the signal is asserted.

Arguments

• level - the level read on the pin.

Returns

true if level asserts the signal under this polarity.

Trait Implementations

impl Clone for Polarity

fn clone(&self) -> Polarity

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for Polarity

impl Debug for Polarity

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

Formats the value using the given formatter.

impl Eq for Polarity

impl PartialEq for Polarity

fn eq(&self, other: &Polarity) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Polarity