Struct asm_delay::Hertz

pub struct Hertz<T = u32>(pub T)
 where
    T: TimeInt;

A frequency unit type

Convertible to/from [Period].

Implementations

impl<T> Hertz<T> where
    T: TimeInt, 

pub fn into_period(self) -> Period<T>

assert_eq!(Hertz(1_000_u32).into_period(), <Period>::new(1, 1_000));

pub fn from_period(period: Period<T>) -> Hertz<T>

assert_eq!(Hertz::from_period(Period::new(1, 1_000)), Hertz(1_000_u32));

Trait Implementations

impl<T> Debug for Hertz<T> where
    T: TimeInt + Debug, 

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

Formats the value using the given formatter.

impl<T, Rhs> Div<Rhs> for Hertz<T> where
    Rhs: TimeInt,
    T: TimeInt + From<Rhs>, 

type Output = Hertz<T>

The resulting type after applying the / operator.

fn div(self, rhs: Rhs) -> <Hertz<T> as Div<Rhs>>::Output

assert_eq!(Hertz(300_u32) / 3_u32, Hertz(100_u32));

impl<T> Eq for Hertz<T> where
    T: TimeInt + Eq, 

impl<T, Rhs> Mul<Rhs> for Hertz<T> where
    Rhs: TimeInt,
    T: TimeInt + From<Rhs>, 

type Output = Hertz<T>

The resulting type after applying the * operator.

fn mul(self, rhs: Rhs) -> <Hertz<T> as Mul<Rhs>>::Output

assert_eq!(Hertz(100_u32) * 3_u32, Hertz(300_u32));

impl<T> Ord for Hertz<T> where
    T: TimeInt + Ord, 

fn cmp(&self, other: &Hertz<T>) -> 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<T> PartialEq<Hertz<T>> for Hertz<T> where
    T: TimeInt + PartialEq<T>, 

fn eq(&self, other: &Hertz<T>) -> bool

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

fn ne(&self, other: &Hertz<T>) -> bool

This method tests for !=.

impl<T> PartialOrd<Hertz<T>> for Hertz<T> where
    T: TimeInt + PartialOrd<T>, 

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

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

fn lt(&self, other: &Hertz<T>) -> bool

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

fn le(&self, other: &Hertz<T>) -> bool

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

fn gt(&self, other: &Hertz<T>) -> bool

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

fn ge(&self, other: &Hertz<T>) -> bool

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

impl<T> StructuralEq for Hertz<T> where
    T: TimeInt, 

impl<T> StructuralPartialEq for Hertz<T> where
    T: TimeInt,