Struct embedded_time::rate::Baud

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

Baud

Implementations

impl<T: TimeInt> Baud<T>

pub fn new(value: T) -> Self

See Constructing a rate

Trait Implementations

impl<T: TimeInt, Rhs: Rate> Add<Rhs> for Baud<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 Baud<T>

fn clone(&self) -> Baud<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 Baud<T>

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

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

Formats the value using the given formatter.

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

fn default() -> Baud<T>

Returns the "default value" for a type.

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

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

See Formatting

impl<T: TimeInt> Div<T> for Baud<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 Baud<T>

impl<T: TimeInt> FixedPoint for Baud<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<Baud<T>> for Generic<T>

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

See Converting to a Generic Rate

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

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

See Converting between Rates

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

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

See Converting between Rates

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

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

See Converting between Rates

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

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

See Converting between Rates

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

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

See Converting between Rates

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

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

See Converting between Rates

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

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

See Converting between Rates

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

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

See Converting between Rates

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

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

See Converting between Rates

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

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

See Converting between Rates

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

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

See Converting between Rates

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

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

See Converting between Rates

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

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

See Converting between Rates

impl<T: Hash + TimeInt> Hash for Baud<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 Baud<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 Baud<T>

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

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

See Comparisons

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

This method tests for !=.

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

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

See Comparisons

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

This method tests for !=.

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

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

See Comparisons

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

This method tests for !=.

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

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

See Comparisons

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

This method tests for !=.

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

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

See Comparisons

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

This method tests for !=.

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

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

See Comparisons

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

This method tests for !=.

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

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

See Comparisons

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

This method tests for !=.

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

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

See Comparisons

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

This method tests for !=.

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

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

See Comparisons

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

This method tests for !=.

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

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

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

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

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

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

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

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

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

fn partial_cmp(&self, rhs: &Megabaud<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 Baud<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 Baud<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 Baud<T>

impl<T: TimeInt, Rhs: Rate> Sub<Rhs> for Baud<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 TryFrom<Baud<u64>> for Mebibaud<u32>

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(small: Baud<u64>) -> Result<Self, Self::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.

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

See Converting between Rates

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

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(small: Baud<u64>) -> Result<Self, Self::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.

fn try_from(small: Baud<u64>) -> Result<Self, Self::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.

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

See Converting between Rates

impl<SourceInt: TimeInt, DestInt: TimeInt> TryFrom<Generic<SourceInt>> for Baud<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<T: TimeInt> TryFrom<Kibibaud<T>> for Baud<T>

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(big: Kibibaud<T>) -> Result<Self, Self::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.

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

See Converting between Rates

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

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(big: Kilobaud<T>) -> Result<Self, Self::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.

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

See Converting between Rates

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

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(big: Mebibaud<T>) -> Result<Self, Self::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.

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

See Converting between Rates

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

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(big: Megabaud<T>) -> Result<Self, Self::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.

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

See Converting between Rates