Struct drv8825::embedded_time::rate::Baud

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

Baud

Implementations

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

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

See Constructing a rate

Trait Implementations

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

type Output = Baud<T>

The resulting type after applying the + operator.

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

See Add/Sub

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

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

Formats the value using the given formatter.

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

pub fn default() -> Baud<T>

Returns the “default value” for a type.

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

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

See Formatting

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

type Output = Baud<T>

The resulting type after applying the / operator.

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

See Mul/Div

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

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

type T = T

The integer (magnitude) type

pub const SCALING_FACTOR: Fraction

The fractional scaling factor

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

pub fn integer(&self) -> &<Baud<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<Baud<T>> for Generic<T> where
    T: TimeInt, 

pub fn from(rate: Baud<T>) -> Generic<T>

See Converting to a Generic Rate

impl<T> From<Baud<T>> for Mebibaud<T> where
    T: TimeInt, 

pub fn from(small: Baud<T>) -> Mebibaud<T>

See Converting between Rates

impl<T> From<Baud<T>> for Megabaud<T> where
    T: TimeInt, 

pub fn from(small: Baud<T>) -> Megabaud<T>

See Converting between Rates

impl<T> From<Baud<T>> for Kibibaud<T> where
    T: TimeInt, 

pub fn from(small: Baud<T>) -> Kibibaud<T>

See Converting between Rates

impl<T> From<Baud<T>> for Kilobaud<T> where
    T: TimeInt, 

pub fn from(small: Baud<T>) -> Kilobaud<T>

See Converting between Rates

impl From<Baud<u32>> for Mebibaud<u64>

pub fn from(small: Baud<u32>) -> Mebibaud<u64>

See Converting between Rates

impl From<Baud<u32>> for Megabaud<u64>

pub fn from(small: Baud<u32>) -> Megabaud<u64>

See Converting between Rates

impl From<Baud<u32>> for Kibibaud<u64>

pub fn from(small: Baud<u32>) -> Kibibaud<u64>

See Converting between Rates

impl From<Baud<u32>> for Kilobaud<u64>

pub fn from(small: Baud<u32>) -> Kilobaud<u64>

See Converting between Rates

impl From<Baud<u32>> for Baud<u64>

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

See Converting between Rates

impl From<Kibibaud<u32>> for Baud<u64>

pub fn from(big: Kibibaud<u32>) -> Baud<u64>

See Converting between Rates

impl From<Kilobaud<u32>> for Baud<u64>

pub fn from(big: Kilobaud<u32>) -> Baud<u64>

See Converting between Rates

impl From<Mebibaud<u32>> for Baud<u64>

pub fn from(big: Mebibaud<u32>) -> Baud<u64>

See Converting between Rates

impl From<Megabaud<u32>> for Baud<u64>

pub fn from(big: Megabaud<u32>) -> Baud<u64>

See Converting between Rates

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

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 Baud<T> where
    T: TimeInt, 

type Output = Baud<T>

The resulting type after applying the * operator.

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

See Mul/Div

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

pub fn cmp(&self, other: &Baud<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<Baud<RhsInt>> for Megabaud<T> where
    T: TimeInt,
    RhsInt: TimeInt,
    Baud<RhsInt>: PartialEq<Megabaud<T>>, 

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

See Comparisons

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

This method tests for !=.

impl<T, RhsInt> PartialEq<Baud<RhsInt>> for Kilobaud<T> where
    T: TimeInt,
    RhsInt: TimeInt,
    Baud<RhsInt>: PartialEq<Kilobaud<T>>, 

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

See Comparisons

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

This method tests for !=.

impl<T, RhsInt> PartialEq<Baud<RhsInt>> for Mebibaud<T> where
    T: TimeInt,
    RhsInt: TimeInt,
    Baud<RhsInt>: PartialEq<Mebibaud<T>>, 

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

See Comparisons

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

This method tests for !=.

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

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

See Comparisons

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

This method tests for !=.

impl<T, RhsInt> PartialEq<Baud<RhsInt>> for Kibibaud<T> where
    T: TimeInt,
    RhsInt: TimeInt,
    Baud<RhsInt>: PartialEq<Kibibaud<T>>, 

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

See Comparisons

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

This method tests for !=.

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

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

See Comparisons

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

This method tests for !=.

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

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

See Comparisons

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

This method tests for !=.

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

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

See Comparisons

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

This method tests for !=.

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

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

See Comparisons

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

This method tests for !=.

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

pub fn partial_cmp(&self, rhs: &Baud<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<Baud<RhsInt>> for Kilobaud<T> where
    T: TimeInt,
    RhsInt: TimeInt,
    Baud<RhsInt>: TryFrom<Kilobaud<T>>,
    Baud<RhsInt>: Ord, 

pub fn partial_cmp(&self, rhs: &Baud<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<Baud<RhsInt>> for Mebibaud<T> where
    T: TimeInt,
    RhsInt: TimeInt,
    Baud<RhsInt>: TryFrom<Mebibaud<T>>,
    Baud<RhsInt>: Ord, 

pub fn partial_cmp(&self, rhs: &Baud<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<Baud<RhsInt>> for Kibibaud<T> where
    T: TimeInt,
    RhsInt: TimeInt,
    Baud<RhsInt>: TryFrom<Kibibaud<T>>,
    Baud<RhsInt>: Ord, 

pub fn partial_cmp(&self, rhs: &Baud<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<Baud<RhsInt>> for Megabaud<T> where
    T: TimeInt,
    RhsInt: TimeInt,
    Baud<RhsInt>: TryFrom<Megabaud<T>>,
    Baud<RhsInt>: Ord, 

pub fn partial_cmp(&self, rhs: &Baud<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<Kibibaud<RhsInt>> for Baud<T> where
    T: TimeInt,
    RhsInt: TimeInt,
    Baud<T>: TryFrom<Kibibaud<RhsInt>>, 

pub fn partial_cmp(&self, rhs: &Kibibaud<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<Kilobaud<RhsInt>> for Baud<T> where
    T: TimeInt,
    RhsInt: TimeInt,
    Baud<T>: TryFrom<Kilobaud<RhsInt>>, 

pub fn partial_cmp(&self, rhs: &Kilobaud<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<Mebibaud<RhsInt>> for Baud<T> where
    T: TimeInt,
    RhsInt: TimeInt,
    Baud<T>: TryFrom<Mebibaud<RhsInt>>, 

pub fn partial_cmp(&self, rhs: &Mebibaud<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<Megabaud<RhsInt>> for Baud<T> where
    T: TimeInt,
    RhsInt: TimeInt,
    Baud<T>: TryFrom<Megabaud<RhsInt>>, 

pub fn partial_cmp(&self, rhs: &Megabaud<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 Baud<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 Baud<T> where
    T: TimeInt,
    Rhs: Rate + FixedPoint,
    Baud<T>: TryFrom<Rhs>, 

type Output = Baud<T>

The resulting type after applying the % operator.

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

See Remainder

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

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

type Output = Baud<T>

The resulting type after applying the - operator.

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

See Add/Sub

impl TryFrom<Baud<u64>> for Megabaud<u32>

type Error = ConversionError

The type returned in the event of a conversion error.

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

See Converting between Rates

impl TryFrom<Baud<u64>> for Kibibaud<u32>

type Error = ConversionError

The type returned in the event of a conversion error.

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

See Converting between Rates

impl TryFrom<Baud<u64>> for Mebibaud<u32>

type Error = ConversionError

The type returned in the event of a conversion error.

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

See Converting between Rates

impl TryFrom<Baud<u64>> for Baud<u32>

type Error = ConversionError

The type returned in the event of a conversion error.

pub fn try_from(
    source: Baud<u64>
) -> Result<Baud<u32>, <Baud<u32> as TryFrom<Baud<u64>>>::Error>

See Converting between Rates

impl TryFrom<Baud<u64>> for Kilobaud<u32>

type Error = ConversionError

The type returned in the event of a conversion error.

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

See Converting between Rates

impl<SourceInt, DestInt> TryFrom<Generic<SourceInt>> for Baud<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<Baud<DestInt>, <Baud<DestInt> as TryFrom<Generic<SourceInt>>>::Error>

See Converting from a Generic Rate

impl<T> TryFrom<Kibibaud<T>> for Baud<T> where
    T: TimeInt, 

type Error = ConversionError

The type returned in the event of a conversion error.

pub fn try_from(
    big: Kibibaud<T>
) -> Result<Baud<T>, <Baud<T> as TryFrom<Kibibaud<T>>>::Error>

See Converting between Rates

impl TryFrom<Kibibaud<u64>> for Baud<u32>

type Error = ConversionError

The type returned in the event of a conversion error.

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

See Converting between Rates

impl<T> TryFrom<Kilobaud<T>> for Baud<T> where
    T: TimeInt, 

type Error = ConversionError

The type returned in the event of a conversion error.

pub fn try_from(
    big: Kilobaud<T>
) -> Result<Baud<T>, <Baud<T> as TryFrom<Kilobaud<T>>>::Error>

See Converting between Rates

impl TryFrom<Kilobaud<u64>> for Baud<u32>

type Error = ConversionError

The type returned in the event of a conversion error.

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

See Converting between Rates

impl<T> TryFrom<Mebibaud<T>> for Baud<T> where
    T: TimeInt, 

type Error = ConversionError

The type returned in the event of a conversion error.

pub fn try_from(
    big: Mebibaud<T>
) -> Result<Baud<T>, <Baud<T> as TryFrom<Mebibaud<T>>>::Error>

See Converting between Rates

impl TryFrom<Mebibaud<u64>> for Baud<u32>

type Error = ConversionError

The type returned in the event of a conversion error.

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

See Converting between Rates

impl<T> TryFrom<Megabaud<T>> for Baud<T> where
    T: TimeInt, 

type Error = ConversionError

The type returned in the event of a conversion error.

pub fn try_from(
    big: Megabaud<T>
) -> Result<Baud<T>, <Baud<T> as TryFrom<Megabaud<T>>>::Error>

See Converting between Rates

impl TryFrom<Megabaud<u64>> for Baud<u32>

type Error = ConversionError

The type returned in the event of a conversion error.

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

See Converting between Rates