Skip to main content

Polarity

Enum Polarity 

Source
pub enum Polarity {
    ActiveHigh,
    ActiveLow,
}
Expand description

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 energize 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§

Source§

impl Polarity

Source

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.

Source

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§

Source§

impl Clone for Polarity

Source§

fn clone(&self) -> Polarity

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Polarity

Source§

impl Debug for Polarity

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for Polarity

Source§

impl PartialEq for Polarity

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Polarity

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

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>,

Source§

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.