Struct drv8825::embedded_time::duration::Generic

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

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

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

Implementations

impl<T> Generic<T>

pub const fn new(integer: T, scaling_factor: Fraction) -> Generic<T>

Constructs a new fixed-point Generic Duration value

pub const fn integer(&self) -> &T

Returns the integer part

pub const fn scaling_factor(&self) -> &Fraction

Returns the scaling factor Fraction part

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

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

Formats the value using the given formatter.

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

pub fn default() -> Generic<T>

Returns the “default value” for a type.

impl<T> Duration for Generic<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 Duration from a named Duration (eg. Milliseconds)

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

Convert to named Rate

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

impl<T> From<Hours<T>> for Generic<T> where
    T: TimeInt, 

pub fn from(duration: Hours<T>) -> Generic<T>

See Converting to a Generic Duration

impl<T> From<Microseconds<T>> for Generic<T> where
    T: TimeInt, 

pub fn from(duration: Microseconds<T>) -> Generic<T>

See Converting to a Generic Duration

impl<T> From<Milliseconds<T>> for Generic<T> where
    T: TimeInt, 

pub fn from(duration: Milliseconds<T>) -> Generic<T>

See Converting to a Generic Duration

impl<T> From<Minutes<T>> for Generic<T> where
    T: TimeInt, 

pub fn from(duration: Minutes<T>) -> Generic<T>

See Converting to a Generic Duration

impl<T> From<Nanoseconds<T>> for Generic<T> where
    T: TimeInt, 

pub fn from(duration: Nanoseconds<T>) -> Generic<T>

See Converting to a Generic Duration

impl<T> From<Seconds<T>> for Generic<T> where
    T: TimeInt, 

pub fn from(duration: Seconds<T>) -> Generic<T>

See Converting to a Generic Duration

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

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

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

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

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

This method tests for !=.

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

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

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

#[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> StructuralEq for Generic<T>

impl<T> StructuralPartialEq for Generic<T>

impl<SourceInt, DestInt> TryFrom<Generic<SourceInt>> for Minutes<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_duration: Generic<SourceInt>
) -> Result<Minutes<DestInt>, <Minutes<DestInt> as TryFrom<Generic<SourceInt>>>::Error>

See Converting from a Generic Duration

impl<SourceInt, DestInt> TryFrom<Generic<SourceInt>> for Hours<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_duration: Generic<SourceInt>
) -> Result<Hours<DestInt>, <Hours<DestInt> as TryFrom<Generic<SourceInt>>>::Error>

See Converting from a Generic Duration

impl<SourceInt, DestInt> TryFrom<Generic<SourceInt>> for Milliseconds<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_duration: Generic<SourceInt>
) -> Result<Milliseconds<DestInt>, <Milliseconds<DestInt> as TryFrom<Generic<SourceInt>>>::Error>

See Converting from a Generic Duration

impl<SourceInt, DestInt> TryFrom<Generic<SourceInt>> for Nanoseconds<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_duration: Generic<SourceInt>
) -> Result<Nanoseconds<DestInt>, <Nanoseconds<DestInt> as TryFrom<Generic<SourceInt>>>::Error>

See Converting from a Generic Duration

impl<SourceInt, DestInt> TryFrom<Generic<SourceInt>> for Microseconds<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_duration: Generic<SourceInt>
) -> Result<Microseconds<DestInt>, <Microseconds<DestInt> as TryFrom<Generic<SourceInt>>>::Error>

See Converting from a Generic Duration

impl<SourceInt, DestInt> TryFrom<Generic<SourceInt>> for Seconds<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_duration: Generic<SourceInt>
) -> Result<Seconds<DestInt>, <Seconds<DestInt> as TryFrom<Generic<SourceInt>>>::Error>

See Converting from a Generic Duration