Struct lpc55_hal::time::Hertz

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

Hertz

Implementations

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

pub fn new(value: T) -> Hertz<T>

See Constructing a rate

Trait Implementations

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

type Output = Hertz<T>

The resulting type after applying the + operator.

pub fn add(self, rhs: Rhs) -> <Hertz<T> as Add<Rhs>>::Output

See Add/Sub

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

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

Formats the value using the given formatter.

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

pub fn default() -> Hertz<T>

Returns the “default value” for a type.

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

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

See Formatting

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

type Output = Hertz<T>

The resulting type after applying the / operator.

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

See Mul/Div

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

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

type T = T

The integer (magnitude) type

pub const SCALING_FACTOR: Fraction

The fractional scaling factor

pub fn new(value: <Hertz<T> as FixedPoint>::T) -> Hertz<T>

pub fn integer(&self) -> &<Hertz<T> as FixedPoint>::T

See Get the integer part

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

Multiply with overflow checking

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

Multiply with overflow checking

pub fn min_value() -> Self::T

Returns the minimum integer value

pub fn max_value() -> Self::T

Returns the maximum integer value

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

pub fn from(small: Hertz<T>) -> Kilohertz<T>

See Converting between Rates

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

pub fn from(small: Hertz<T>) -> Megahertz<T>

See Converting between Rates

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

pub fn from(small: Hertz<u32>) -> Kilohertz<u64>

See Converting between Rates

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

pub fn from(small: Hertz<u32>) -> Megahertz<u64>

See Converting between Rates

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

pub fn from(source: Hertz<u32>) -> Hertz<u64>

See Converting between Rates

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

pub fn from(big: Kibihertz<u32>) -> Hertz<u64>

See Converting between Rates

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

pub fn from(big: Kilohertz<u32>) -> Hertz<u64>

See Converting between Rates

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

pub fn from(big: Mebihertz<u32>) -> Hertz<u64>

See Converting between Rates

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

pub fn from(big: Megahertz<u32>) -> Hertz<u64>

See Converting between Rates

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

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

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

type Output = Hertz<T>

The resulting type after applying the * operator.

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

See Mul/Div

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

pub fn cmp(&self, other: &Hertz<T>) -> Ordering

This method returns an Ordering between self and other.

#[must_use]

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

Compares and returns the maximum of two values.

#[must_use]

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

Compares and returns the minimum of two values.

#[must_use]

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

Restrict a value to a certain interval.

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

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

See Comparisons

#[must_use]

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

This method tests for !=.

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

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

See Comparisons

#[must_use]

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

This method tests for !=.

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

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

See Comparisons

#[must_use]

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

This method tests for !=.

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

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

See Comparisons

#[must_use]

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

This method tests for !=.

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

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

See Comparisons

#[must_use]

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

This method tests for !=.

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

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

See Comparisons

#[must_use]

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

This method tests for !=.

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

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

See Comparisons

#[must_use]

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

This method tests for !=.

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

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

See Comparisons

#[must_use]

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

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

#[must_use]

pub 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]

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

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

#[must_use]

pub 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, RhsInt> PartialOrd<Hertz<RhsInt>> for Kilohertz<T> where
    T: TimeInt,
    RhsInt: TimeInt,
    Hertz<RhsInt>: TryFrom<Kilohertz<T>>,
    Hertz<RhsInt>: Ord, 

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

See Comparisons

#[must_use]

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

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

#[must_use]

pub 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]

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

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

#[must_use]

pub 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, RhsInt> PartialOrd<Hertz<RhsInt>> for Megahertz<T> where
    T: TimeInt,
    RhsInt: TimeInt,
    Hertz<RhsInt>: TryFrom<Megahertz<T>>,
    Hertz<RhsInt>: Ord, 

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

See Comparisons

#[must_use]

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

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

#[must_use]

pub 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]

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

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

#[must_use]

pub 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, RhsInt> PartialOrd<Kibihertz<RhsInt>> for Hertz<T> where
    T: TimeInt,
    RhsInt: TimeInt,
    Hertz<T>: TryFrom<Kibihertz<RhsInt>>, 

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

See Comparisons

#[must_use]

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

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

#[must_use]

pub 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]

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

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

#[must_use]

pub 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, RhsInt> PartialOrd<Kilohertz<RhsInt>> for Hertz<T> where
    T: TimeInt,
    RhsInt: TimeInt,
    Hertz<T>: TryFrom<Kilohertz<RhsInt>>, 

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

See Comparisons

#[must_use]

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

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

#[must_use]

pub 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]

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

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

#[must_use]

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

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

See Comparisons

#[must_use]

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

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

#[must_use]

pub 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]

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

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

#[must_use]

pub 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, RhsInt> PartialOrd<Megahertz<RhsInt>> for Hertz<T> where
    T: TimeInt,
    RhsInt: TimeInt,
    Hertz<T>: TryFrom<Megahertz<RhsInt>>, 

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

See Comparisons

#[must_use]

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

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

#[must_use]

pub 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]

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

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

#[must_use]

pub 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> Rate for Hertz<T> where
    T: TimeInt, 

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

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

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

Convert to named Duration

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

type Output = Hertz<T>

The resulting type after applying the % operator.

pub fn rem(self, rhs: Rhs) -> <Hertz<T> as Rem<Rhs>>::Output

See Remainder

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

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

type Output = Hertz<T>

The resulting type after applying the - operator.

pub fn sub(self, rhs: Rhs) -> <Hertz<T> as Sub<Rhs>>::Output

See Add/Sub

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

type Error = ConversionError

The type returned in the event of a conversion error.

pub fn try_from(
    generic_rate: Generic<SourceInt>
) -> Result<Hertz<DestInt>, <Hertz<DestInt> as TryFrom<Generic<SourceInt>>>::Error>

See Converting from a Generic Rate

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

type Error = ConversionError

The type returned in the event of a conversion error.

pub fn try_from(
    source: Hertz<u64>
) -> Result<Hertz<u32>, <Hertz<u32> as TryFrom<Hertz<u64>>>::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.

pub fn try_from(
    small: Hertz<u64>
) -> Result<Kilohertz<u32>, <Kilohertz<u32> as TryFrom<Hertz<u64>>>::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.

pub fn try_from(
    small: Hertz<u64>
) -> Result<Megahertz<u32>, <Megahertz<u32> as TryFrom<Hertz<u64>>>::Error>

See Converting between Rates

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

type Error = ConversionError

The type returned in the event of a conversion error.

pub fn try_from(
    big: Kibihertz<T>
) -> Result<Hertz<T>, <Hertz<T> as TryFrom<Kibihertz<T>>>::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.

pub fn try_from(
    big: Kibihertz<u64>
) -> Result<Hertz<u32>, <Hertz<u32> as TryFrom<Kibihertz<u64>>>::Error>

See Converting between Rates

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

type Error = ConversionError

The type returned in the event of a conversion error.

pub fn try_from(
    big: Kilohertz<T>
) -> Result<Hertz<T>, <Hertz<T> as TryFrom<Kilohertz<T>>>::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.

pub fn try_from(
    big: Kilohertz<u64>
) -> Result<Hertz<u32>, <Hertz<u32> as TryFrom<Kilohertz<u64>>>::Error>

See Converting between Rates

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

type Error = ConversionError

The type returned in the event of a conversion error.

pub fn try_from(
    big: Mebihertz<T>
) -> Result<Hertz<T>, <Hertz<T> as TryFrom<Mebihertz<T>>>::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.

pub fn try_from(
    big: Mebihertz<u64>
) -> Result<Hertz<u32>, <Hertz<u32> as TryFrom<Mebihertz<u64>>>::Error>

See Converting between Rates

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

type Error = ConversionError

The type returned in the event of a conversion error.

pub fn try_from(
    big: Megahertz<T>
) -> Result<Hertz<T>, <Hertz<T> as TryFrom<Megahertz<T>>>::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.

pub fn try_from(
    big: Megahertz<u64>
) -> Result<Hertz<u32>, <Hertz<u32> as TryFrom<Megahertz<u64>>>::Error>

See Converting between Rates