Struct MaybeHertz

#[repr(C)]
pub struct MaybeHertz(/* private fields */);

A variant on Hertz that acts as an Option<Hertz> that is smaller and repr C.

An Option<Hertz> can be .into()’d into this type and back. The only restriction is that that Hertz cannot have the value 0 since that’s seen as the None variant.

Implementations

impl MaybeHertz

pub fn to_hertz(self) -> Option<Hertz>

Same as calling the .into() function, but without type inference.

Trait Implementations

impl Clone for MaybeHertz

fn clone(&self) -> MaybeHertz

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MaybeHertz

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

Formats the value using the given formatter.

impl Default for MaybeHertz

fn default() -> MaybeHertz

Returns the “default value” for a type.

impl Format for MaybeHertz

fn format(&self, f: Formatter<'_>)

Writes the defmt representation of self to fmt.

impl From<MaybeHertz> for Option<Hertz>

fn from(value: MaybeHertz) -> Self

Converts to this type from the input type.

impl From<Option<Hertz>> for MaybeHertz

fn from(value: Option<Hertz>) -> Self

Converts to this type from the input type.

impl Ord for MaybeHertz

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for MaybeHertz

fn eq(&self, other: &MaybeHertz) -> 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 PartialOrd for MaybeHertz

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for MaybeHertz

impl Eq for MaybeHertz

impl StructuralPartialEq for MaybeHertz