Struct embedded_time::units::Hertz

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

A frequency unit type

Convertible to/from Period.

Trait Implementations

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

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

Formats the value using the given formatter.

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

type Output = Self

The resulting type after applying the / operator.

fn div(self, rhs: Rhs) -> Self::Output

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

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

impl From<Hertz<u32>> for u32

fn from(hertz: Hertz) -> Self

assert_eq!(u32::from(Hertz(23)), 23_u32);
assert_eq!(<u32 as Into<Hertz>>::into(23), Hertz(23_u32));

impl From<u32> for Hertz

fn from(value: u32) -> Self

assert_eq!(Hertz::from(23), Hertz(23_u32));
assert_eq!(<Hertz as Into<u32>>::into(Hertz(23_u32)), 23_u32);

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

type Output = Self

The resulting type after applying the * operator.

fn mul(self, rhs: Rhs) -> Self::Output

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

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

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 + TimeInt> PartialEq<Hertz<T>> for Hertz<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 + TimeInt> PartialOrd<Hertz<T>> for Hertz<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: TimeInt> StructuralEq for Hertz<T>

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

impl<T: TimeInt> TryFrom<Hertz<T>> for Period<T>

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(freq: Hertz<T>) -> Result<Self, Self::Error>

Constructs a Period in seconds from a frequency in Hertz

Examples

assert_eq!(Period::try_from(Hertz(1_000_u32)),
    Ok(<Period>::new(1, 1_000)));

assert_eq!(Period::try_from(Hertz(0_u32)),
    Err(ConversionError::DivByZero));

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

Errors

ConversionError::DivByZero

impl<T: TimeInt> TryFrom<Period<T>> for Hertz<T>

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(period: Period<T>) -> Result<Self, Self::Error>

Create a new Frequency from a fractional Period in seconds

Examples

assert_eq!(Hertz::try_from(<Period>::new(1, 1_000)),
    Ok(Hertz(1_000_u32)));

assert_eq!(Hertz::try_from(<Period>::new(0, 1_000)),
    Err(ConversionError::DivByZero));

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

Errors

ConversionError::DivByZero