Struct embedded_time::rate::Hertz

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

Hertz

Implementations

impl<T: TimeInt> Hertz<T>

pub fn new(value: T) -> Self

See Constructing a rate

Trait Implementations

impl<T: TimeInt, Rhs: Rate> Add<Rhs> for Hertz<T> where
    Rhs: FixedPoint,
    Self: TryFrom<Rhs>, 

type Output = Self

The resulting type after applying the + operator.

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

See Add/Sub

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

fn clone(&self) -> Hertz<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

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

Formats the value using the given formatter.

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

fn default() -> Hertz<T>

Returns the "default value" for a type.

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

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

See Formatting

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

type Output = Self

The resulting type after applying the / operator.

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

See Mul/Div

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

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

type T = T

The integer (magnitude) type

const SCALING_FACTOR: Fraction

The fractional scaling factor

fn new(value: Self::T) -> Self

fn integer(&self) -> &Self::T

See Get the integer part

fn checked_mul(&self, rhs: &Self::T) -> Option<Self>

Multiply with overflow checking

fn checked_div(&self, rhs: &Self::T) -> Option<Self>

Multiply with overflow checking

fn min_value() -> Self::T

Returns the minimum integer value

fn max_value() -> Self::T

Returns the maximum integer value

impl<T: TimeInt> From<Hertz<T>> for Generic<T>

fn from(rate: Hertz<T>) -> Self

See Converting to a Generic Rate

impl<T: TimeInt> From<Hertz<T>> for Mebihertz<T>

fn from(small: Hertz<T>) -> Self

See Converting between Rates

impl<T: TimeInt> From<Hertz<T>> for Kibihertz<T>

fn from(small: Hertz<T>) -> Self

See Converting between Rates

impl<T: TimeInt> From<Hertz<T>> for Megahertz<T>

fn from(small: Hertz<T>) -> Self

See Converting between Rates

impl<T: TimeInt> From<Hertz<T>> for Kilohertz<T>

fn from(small: Hertz<T>) -> Self

See Converting between Rates

impl From<Hertz<u32>> for Mebihertz<u64>

fn from(small: Hertz<u32>) -> Self

See Converting between Rates

impl From<Hertz<u32>> for Kibihertz<u64>

fn from(small: Hertz<u32>) -> Self

See Converting between Rates

impl From<Hertz<u32>> for Megahertz<u64>

fn from(small: Hertz<u32>) -> Self

See Converting between Rates

impl From<Hertz<u32>> for Kilohertz<u64>

fn from(small: Hertz<u32>) -> Self

See Converting between Rates

impl From<Hertz<u32>> for Hertz<u64>

fn from(source: Hertz<u32>) -> Self

See Converting between Rates

impl From<Kibihertz<u32>> for Hertz<u64>

fn from(big: Kibihertz<u32>) -> Self

See Converting between Rates

impl From<Kilohertz<u32>> for Hertz<u64>

fn from(big: Kilohertz<u32>) -> Self

See Converting between Rates

impl From<Mebihertz<u32>> for Hertz<u64>

fn from(big: Mebihertz<u32>) -> Self

See Converting between Rates

impl From<Megahertz<u32>> for Hertz<u64>

fn from(big: Megahertz<u32>) -> Self

See Converting between Rates

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

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<T: TimeInt> Mul<T> for Hertz<T>

type Output = Self

The resulting type after applying the * operator.

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

See Mul/Div

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: TimeInt, RhsInt: TimeInt> PartialEq<Hertz<RhsInt>> for Mebihertz<T> where
    Hertz<RhsInt>: PartialEq<Mebihertz<T>>, 

fn eq(&self, rhs: &Hertz<RhsInt>) -> bool

See Comparisons

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T: TimeInt, RhsInt: TimeInt> PartialEq<Hertz<RhsInt>> for Kibihertz<T> where
    Hertz<RhsInt>: PartialEq<Kibihertz<T>>, 

fn eq(&self, rhs: &Hertz<RhsInt>) -> bool

See Comparisons

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T: TimeInt, RhsInt: TimeInt> PartialEq<Hertz<RhsInt>> for Megahertz<T> where
    Hertz<RhsInt>: PartialEq<Megahertz<T>>, 

fn eq(&self, rhs: &Hertz<RhsInt>) -> bool

See Comparisons

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T: TimeInt, RhsInt: TimeInt> PartialEq<Hertz<RhsInt>> for Kilohertz<T> where
    Hertz<RhsInt>: PartialEq<Kilohertz<T>>, 

fn eq(&self, rhs: &Hertz<RhsInt>) -> bool

See Comparisons

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T: TimeInt, RhsInt: TimeInt> PartialEq<Hertz<RhsInt>> for Hertz<T> where
    T: TryFrom<RhsInt>, 

fn eq(&self, rhs: &Hertz<RhsInt>) -> bool

See Comparisons

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T: TimeInt, RhsInt: TimeInt> PartialEq<Kibihertz<RhsInt>> for Hertz<T> where
    Self: TryFrom<Kibihertz<RhsInt>>, 

fn eq(&self, rhs: &Kibihertz<RhsInt>) -> bool

See Comparisons

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T: TimeInt, RhsInt: TimeInt> PartialEq<Kilohertz<RhsInt>> for Hertz<T> where
    Self: TryFrom<Kilohertz<RhsInt>>, 

fn eq(&self, rhs: &Kilohertz<RhsInt>) -> bool

See Comparisons

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T: TimeInt, RhsInt: TimeInt> PartialEq<Mebihertz<RhsInt>> for Hertz<T> where
    Self: TryFrom<Mebihertz<RhsInt>>, 

fn eq(&self, rhs: &Mebihertz<RhsInt>) -> bool

See Comparisons

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T: TimeInt, RhsInt: TimeInt> PartialEq<Megahertz<RhsInt>> for Hertz<T> where
    Self: TryFrom<Megahertz<RhsInt>>, 

fn eq(&self, rhs: &Megahertz<RhsInt>) -> bool

See Comparisons

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T: TimeInt, RhsInt: TimeInt> PartialOrd<Hertz<RhsInt>> for Mebihertz<T> where
    Hertz<RhsInt>: TryFrom<Self> + Ord, 

fn partial_cmp(&self, rhs: &Hertz<RhsInt>) -> Option<Ordering>

See Comparisons

#[must_use]fn lt(&self, other: &Rhs) -> bool

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

#[must_use]fn le(&self, other: &Rhs) -> bool

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

#[must_use]fn gt(&self, other: &Rhs) -> bool

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

#[must_use]fn ge(&self, other: &Rhs) -> bool

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

impl<T: TimeInt, RhsInt: TimeInt> PartialOrd<Hertz<RhsInt>> for Kibihertz<T> where
    Hertz<RhsInt>: TryFrom<Self> + Ord, 

fn partial_cmp(&self, rhs: &Hertz<RhsInt>) -> Option<Ordering>

See Comparisons

#[must_use]fn lt(&self, other: &Rhs) -> bool

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

#[must_use]fn le(&self, other: &Rhs) -> bool

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

#[must_use]fn gt(&self, other: &Rhs) -> bool

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

#[must_use]fn ge(&self, other: &Rhs) -> bool

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

impl<T: TimeInt, RhsInt: TimeInt> PartialOrd<Hertz<RhsInt>> for Megahertz<T> where
    Hertz<RhsInt>: TryFrom<Self> + Ord, 

fn partial_cmp(&self, rhs: &Hertz<RhsInt>) -> Option<Ordering>

See Comparisons

#[must_use]fn lt(&self, other: &Rhs) -> bool

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

#[must_use]fn le(&self, other: &Rhs) -> bool

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

#[must_use]fn gt(&self, other: &Rhs) -> bool

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

#[must_use]fn ge(&self, other: &Rhs) -> bool

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

impl<T: TimeInt, RhsInt: TimeInt> PartialOrd<Hertz<RhsInt>> for Kilohertz<T> where
    Hertz<RhsInt>: TryFrom<Self> + Ord, 

fn partial_cmp(&self, rhs: &Hertz<RhsInt>) -> Option<Ordering>

See Comparisons

#[must_use]fn lt(&self, other: &Rhs) -> bool

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

#[must_use]fn le(&self, other: &Rhs) -> bool

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

#[must_use]fn gt(&self, other: &Rhs) -> bool

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

#[must_use]fn ge(&self, other: &Rhs) -> bool

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

impl<T: TimeInt, RhsInt: TimeInt> PartialOrd<Hertz<RhsInt>> for Hertz<T> where
    T: TryFrom<RhsInt>, 

fn partial_cmp(&self, rhs: &Hertz<RhsInt>) -> Option<Ordering>

See Comparisons

#[must_use]fn lt(&self, other: &Rhs) -> bool

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

#[must_use]fn le(&self, other: &Rhs) -> bool

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

#[must_use]fn gt(&self, other: &Rhs) -> bool

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

#[must_use]fn ge(&self, other: &Rhs) -> bool

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

impl<T: TimeInt, RhsInt: TimeInt> PartialOrd<Kibihertz<RhsInt>> for Hertz<T> where
    Self: TryFrom<Kibihertz<RhsInt>>, 

fn partial_cmp(&self, rhs: &Kibihertz<RhsInt>) -> Option<Ordering>

See Comparisons

#[must_use]fn lt(&self, other: &Rhs) -> bool

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

#[must_use]fn le(&self, other: &Rhs) -> bool

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

#[must_use]fn gt(&self, other: &Rhs) -> bool

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

#[must_use]fn ge(&self, other: &Rhs) -> bool

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

impl<T: TimeInt, RhsInt: TimeInt> PartialOrd<Kilohertz<RhsInt>> for Hertz<T> where
    Self: TryFrom<Kilohertz<RhsInt>>, 

fn partial_cmp(&self, rhs: &Kilohertz<RhsInt>) -> Option<Ordering>

See Comparisons

#[must_use]fn lt(&self, other: &Rhs) -> bool

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

#[must_use]fn le(&self, other: &Rhs) -> bool

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

#[must_use]fn gt(&self, other: &Rhs) -> bool

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

#[must_use]fn ge(&self, other: &Rhs) -> bool

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

impl<T: TimeInt, RhsInt: TimeInt> PartialOrd<Mebihertz<RhsInt>> for Hertz<T> where
    Self: TryFrom<Mebihertz<RhsInt>>, 

fn partial_cmp(&self, rhs: &Mebihertz<RhsInt>) -> Option<Ordering>

See Comparisons

#[must_use]fn lt(&self, other: &Rhs) -> bool

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

#[must_use]fn le(&self, other: &Rhs) -> bool

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

#[must_use]fn gt(&self, other: &Rhs) -> bool

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

#[must_use]fn ge(&self, other: &Rhs) -> bool

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

impl<T: TimeInt, RhsInt: TimeInt> PartialOrd<Megahertz<RhsInt>> for Hertz<T> where
    Self: TryFrom<Megahertz<RhsInt>>, 

fn partial_cmp(&self, rhs: &Megahertz<RhsInt>) -> Option<Ordering>

See Comparisons

#[must_use]fn lt(&self, other: &Rhs) -> bool

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

#[must_use]fn le(&self, other: &Rhs) -> bool

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

#[must_use]fn gt(&self, other: &Rhs) -> bool

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

#[must_use]fn ge(&self, other: &Rhs) -> bool

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

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

fn to_generic<DestInt: TimeInt>(
    self,
    scaling_factor: Fraction
) -> Result<Generic<DestInt>, ConversionError> where
    Self: FixedPoint,
    DestInt: TryFrom<Self::T>, 

Construct a Generic Rate from a named Rate (eg. Kilohertz)

fn to_duration<Duration: Duration>(&self) -> Result<Duration, ConversionError> where
    Duration: FixedPoint,
    Self: FixedPoint,
    Duration::T: TryFrom<Self::T>, 

Convert to named Duration

impl<T: TimeInt, Rhs: Rate> Rem<Rhs> for Hertz<T> where
    Self: TryFrom<Rhs>,
    Rhs: FixedPoint, 

type Output = Self

The resulting type after applying the % operator.

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

See Remainder

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

impl<T: TimeInt, Rhs: Rate> Sub<Rhs> for Hertz<T> where
    Self: TryFrom<Rhs>,
    Rhs: FixedPoint, 

type Output = Self

The resulting type after applying the - operator.

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

See Add/Sub

impl<SourceInt: TimeInt, DestInt: TimeInt> TryFrom<Generic<SourceInt>> for Hertz<DestInt> where
    DestInt: TryFrom<SourceInt>, 

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(generic_rate: Generic<SourceInt>) -> Result<Self, Self::Error>

See Converting from a Generic Rate

impl TryFrom<Hertz<u64>> for Mebihertz<u32>

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(small: Hertz<u64>) -> Result<Self, Self::Error>

See Converting between Rates

impl TryFrom<Hertz<u64>> for Kibihertz<u32>

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(small: Hertz<u64>) -> Result<Self, Self::Error>

See Converting between Rates

impl TryFrom<Hertz<u64>> for Megahertz<u32>

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(small: Hertz<u64>) -> Result<Self, Self::Error>

See Converting between Rates

impl TryFrom<Hertz<u64>> for Kilohertz<u32>

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(small: Hertz<u64>) -> Result<Self, Self::Error>

See Converting between Rates

impl TryFrom<Hertz<u64>> for Hertz<u32>

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(source: Hertz<u64>) -> Result<Self, Self::Error>

See Converting between Rates

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

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(big: Kibihertz<T>) -> Result<Self, Self::Error>

See Converting between Rates

impl TryFrom<Kibihertz<u64>> for Hertz<u32>

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(big: Kibihertz<u64>) -> Result<Self, Self::Error>

See Converting between Rates

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

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(big: Kilohertz<T>) -> Result<Self, Self::Error>

See Converting between Rates

impl TryFrom<Kilohertz<u64>> for Hertz<u32>

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(big: Kilohertz<u64>) -> Result<Self, Self::Error>

See Converting between Rates

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

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(big: Mebihertz<T>) -> Result<Self, Self::Error>

See Converting between Rates

impl TryFrom<Mebihertz<u64>> for Hertz<u32>

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(big: Mebihertz<u64>) -> Result<Self, Self::Error>

See Converting between Rates

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

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(big: Megahertz<T>) -> Result<Self, Self::Error>

See Converting between Rates

impl TryFrom<Megahertz<u64>> for Hertz<u32>

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(big: Megahertz<u64>) -> Result<Self, Self::Error>

See Converting between Rates