Struct embedded_time::rate::Generic

pub struct Generic<T> { /* fields omitted */ }

The Generic Rate type allows an arbitrary scaling factor to be used without having to impl FixedPoint.

The purpose of this type is to allow a simple Rate object that can be defined at run-time. It does this by replacing the const scaling factor with a struct field.

Implementations

impl<T: TimeInt> Generic<T>

pub fn new(integer: T, scaling_factor: Fraction) -> Self

Constructs a new fixed-point Generic Rate value

pub fn integer(&self) -> T

Returns the integer part

pub fn scaling_factor(&self) -> &Fraction

Returns the scaling factor Fraction part

Trait Implementations

impl<T: Clone> Clone for Generic<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Generic<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for Generic<T>

fn default() -> Generic<T>

Returns the “default value” for a type.

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<BitsPerSecond<T>> for Generic<T>

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

See Converting to a Generic Rate

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

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

See Converting to a Generic Rate

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

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

See Converting to a Generic Rate

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

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

See Converting to a Generic Rate

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<Kibibaud<T>> for Generic<T>

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

See Converting to a Generic Rate

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

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

See Converting to a Generic Rate

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

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

See Converting to a Generic Rate

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

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

See Converting to a Generic Rate

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

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

See Converting to a Generic Rate

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

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

See Converting to a Generic Rate

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

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

See Converting to a Generic Rate

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

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

See Converting to a Generic Rate

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

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

See Converting to a Generic Rate

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

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

See Converting to a Generic Rate

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

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

See Converting to a Generic Rate

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

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

See Converting to a Generic Rate

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

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

See Converting to a Generic Rate

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

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

See Converting to a Generic Rate

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

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

See Converting to a Generic Rate

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

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

See Converting to a Generic Rate

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

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

See Converting to a Generic Rate

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

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

See Converting to a Generic Rate

impl<T: Hash> Hash for Generic<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: Ord> Ord for Generic<T>

fn cmp(&self, other: &Generic<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

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq<Generic<T>> for Generic<T>

fn eq(&self, other: &Generic<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Generic<T>) -> bool

This method tests for !=.

impl<T: PartialOrd> PartialOrd<Generic<T>> for Generic<T>

fn partial_cmp(&self, other: &Generic<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[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 Generic<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<SourceInt: TimeInt, DestInt: TimeInt> TryFrom<Generic<SourceInt>> for Mebihertz<DestInt> where
    DestInt: TryFrom<SourceInt>, 

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

See Converting from a Generic Rate

type Error = ConversionError

The type returned in the event of a conversion error.

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

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

See Converting from a Generic Rate

type Error = ConversionError

The type returned in the event of a conversion error.

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

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

See Converting from a Generic Rate

type Error = ConversionError

The type returned in the event of a conversion error.

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

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

See Converting from a Generic Rate

type Error = ConversionError

The type returned in the event of a conversion error.

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

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

See Converting from a Generic Rate

type Error = ConversionError

The type returned in the event of a conversion error.

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

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

See Converting from a Generic Rate

type Error = ConversionError

The type returned in the event of a conversion error.

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

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

See Converting from a Generic Rate

type Error = ConversionError

The type returned in the event of a conversion error.

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

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

See Converting from a Generic Rate

type Error = ConversionError

The type returned in the event of a conversion error.

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

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

See Converting from a Generic Rate

type Error = ConversionError

The type returned in the event of a conversion error.

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

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

See Converting from a Generic Rate

type Error = ConversionError

The type returned in the event of a conversion error.

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

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

See Converting from a Generic Rate

type Error = ConversionError

The type returned in the event of a conversion error.

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

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

See Converting from a Generic Rate

type Error = ConversionError

The type returned in the event of a conversion error.

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

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

See Converting from a Generic Rate

type Error = ConversionError

The type returned in the event of a conversion error.

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

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

See Converting from a Generic Rate

type Error = ConversionError

The type returned in the event of a conversion error.

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

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

See Converting from a Generic Rate

type Error = ConversionError

The type returned in the event of a conversion error.

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

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

See Converting from a Generic Rate

type Error = ConversionError

The type returned in the event of a conversion error.

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

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

See Converting from a Generic Rate

type Error = ConversionError

The type returned in the event of a conversion error.

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

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

See Converting from a Generic Rate

type Error = ConversionError

The type returned in the event of a conversion error.

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

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

See Converting from a Generic Rate

type Error = ConversionError

The type returned in the event of a conversion error.

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

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

See Converting from a Generic Rate

type Error = ConversionError

The type returned in the event of a conversion error.

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

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

See Converting from a Generic Rate

type Error = ConversionError

The type returned in the event of a conversion error.

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

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

See Converting from a Generic Rate

type Error = ConversionError

The type returned in the event of a conversion error.

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

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

See Converting from a Generic Rate

type Error = ConversionError

The type returned in the event of a conversion error.

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

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

See Converting from a Generic Rate

type Error = ConversionError

The type returned in the event of a conversion error.

impl<T: Copy> Copy for Generic<T>

impl<T: Eq> Eq for Generic<T>

impl<T> StructuralEq for Generic<T>

impl<T> StructuralPartialEq for Generic<T>