Struct apigpio::WaveId

pub struct WaveId(pub Word);

Refers to a Wave stored in pigpiod.

See the pigpio wave documentaton. In pigpiod Wave IDs are global across all pigpio clients, and waves not cleared (nor transmission stopped!) when a client disconnects.

Because of safety concerns (see particularly the pigpio documentation about wave *SYNC*), waves are not automatically deleted when a WaveID is dropped. The best approach is usually to use wave_clear on program startup.

The inner Word is available in case you need to do something exciting (maybe something cross-process).

Trait Implementations

impl Clone for WaveId

fn clone(&self) -> WaveId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for WaveId

impl Debug for WaveId

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

Formats the value using the given formatter.

impl Display for WaveId

fn fmt(&self, fmt: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.

impl Eq for WaveId

impl Hash for WaveId

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Ord for WaveId

fn cmp(&self, other: &WaveId) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<WaveId> for WaveId

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<WaveId> for WaveId

fn partial_cmp(&self, other: &WaveId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &WaveId) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &WaveId) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &WaveId) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &WaveId) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for WaveId

impl StructuralPartialEq for WaveId