Struct embedded_time::duration::Generic

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

The Generic Duration type allows arbitrary _scaling factor_s to be used without having to impl FixedPoint.

The purpose of this type is to allow a simple Duration 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) -> Self

Constructs a new (ram) fixed-point Generic Duration value

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

Returns the integer value

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

Returns the scaling factor Fraction value

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: Copy> Copy for Generic<T>

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

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

Formats the value using the given formatter.

impl<T: TimeInt> Duration for Generic<T>

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

Construct a Generic Duration from an named Duration (eg. Milliseconds)

fn try_from_rate<Rate: Rate>(rate: Rate) -> Result<Self, ConversionError> where
    Rate: FixedPoint,
    u32: TryFrom<Rate::T>,
    Self: FixedPoint,
    Self::T: TryFrom<Rate::T>, 

Attempt to construct the given duration type from the given rate type

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

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

impl<T> StructuralPartialEq for Generic<T>

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

type Error = ConversionError

The type returned in the event of a conversion error.

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

Construct a named Duration from a Generic Duration

Examples

assert_eq!(
    Seconds::<u64>::try_from(Generic::new(2_000_u32, Fraction::new(1, 1_000))),
    Ok(Seconds(2_u64))
);

// TryInto also works
assert_eq!(
    Generic::new(2_000_u64, Fraction::new(1, 1_000)).try_into(),
    Ok(Seconds(2_u64))
);

Errors

Failure will only occur if the provided value does not fit in the selected destination type.

---

ConversionError::Overflow : The conversion of the scaling factor causes an overflow.

assert_eq!(
    Seconds::<u32>::try_from(Generic::new(u32::MAX, Fraction::new(10,1))),
    Err(ConversionError::Overflow)
);

---

ConversionError::ConversionFailure : The integer conversion to that of the destination type fails.

assert_eq!(
    Seconds::<u32>::try_from(Generic::new(u32::MAX as u64 + 1, Fraction::new(1,1))),
    Err(ConversionError::ConversionFailure)
);

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

type Error = ConversionError

The type returned in the event of a conversion error.

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

Construct a named Duration from a Generic Duration

Examples

assert_eq!(
    Seconds::<u64>::try_from(Generic::new(2_000_u32, Fraction::new(1, 1_000))),
    Ok(Seconds(2_u64))
);

// TryInto also works
assert_eq!(
    Generic::new(2_000_u64, Fraction::new(1, 1_000)).try_into(),
    Ok(Seconds(2_u64))
);

Errors

Failure will only occur if the provided value does not fit in the selected destination type.

---

ConversionError::Overflow : The conversion of the scaling factor causes an overflow.

assert_eq!(
    Seconds::<u32>::try_from(Generic::new(u32::MAX, Fraction::new(10,1))),
    Err(ConversionError::Overflow)
);

---

ConversionError::ConversionFailure : The integer conversion to that of the destination type fails.

assert_eq!(
    Seconds::<u32>::try_from(Generic::new(u32::MAX as u64 + 1, Fraction::new(1,1))),
    Err(ConversionError::ConversionFailure)
);

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

type Error = ConversionError

The type returned in the event of a conversion error.

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

Construct a named Duration from a Generic Duration

Examples

assert_eq!(
    Seconds::<u64>::try_from(Generic::new(2_000_u32, Fraction::new(1, 1_000))),
    Ok(Seconds(2_u64))
);

// TryInto also works
assert_eq!(
    Generic::new(2_000_u64, Fraction::new(1, 1_000)).try_into(),
    Ok(Seconds(2_u64))
);

Errors

Failure will only occur if the provided value does not fit in the selected destination type.

---

ConversionError::Overflow : The conversion of the scaling factor causes an overflow.

assert_eq!(
    Seconds::<u32>::try_from(Generic::new(u32::MAX, Fraction::new(10,1))),
    Err(ConversionError::Overflow)
);

---

ConversionError::ConversionFailure : The integer conversion to that of the destination type fails.

assert_eq!(
    Seconds::<u32>::try_from(Generic::new(u32::MAX as u64 + 1, Fraction::new(1,1))),
    Err(ConversionError::ConversionFailure)
);

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

type Error = ConversionError

The type returned in the event of a conversion error.

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

Construct a named Duration from a Generic Duration

Examples

assert_eq!(
    Seconds::<u64>::try_from(Generic::new(2_000_u32, Fraction::new(1, 1_000))),
    Ok(Seconds(2_u64))
);

// TryInto also works
assert_eq!(
    Generic::new(2_000_u64, Fraction::new(1, 1_000)).try_into(),
    Ok(Seconds(2_u64))
);

Errors

Failure will only occur if the provided value does not fit in the selected destination type.

---

ConversionError::Overflow : The conversion of the scaling factor causes an overflow.

assert_eq!(
    Seconds::<u32>::try_from(Generic::new(u32::MAX, Fraction::new(10,1))),
    Err(ConversionError::Overflow)
);

---

ConversionError::ConversionFailure : The integer conversion to that of the destination type fails.

assert_eq!(
    Seconds::<u32>::try_from(Generic::new(u32::MAX as u64 + 1, Fraction::new(1,1))),
    Err(ConversionError::ConversionFailure)
);

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

type Error = ConversionError

The type returned in the event of a conversion error.

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

Construct a named Duration from a Generic Duration

Examples

assert_eq!(
    Seconds::<u64>::try_from(Generic::new(2_000_u32, Fraction::new(1, 1_000))),
    Ok(Seconds(2_u64))
);

// TryInto also works
assert_eq!(
    Generic::new(2_000_u64, Fraction::new(1, 1_000)).try_into(),
    Ok(Seconds(2_u64))
);

Errors

Failure will only occur if the provided value does not fit in the selected destination type.

---

ConversionError::Overflow : The conversion of the scaling factor causes an overflow.

assert_eq!(
    Seconds::<u32>::try_from(Generic::new(u32::MAX, Fraction::new(10,1))),
    Err(ConversionError::Overflow)
);

---

ConversionError::ConversionFailure : The integer conversion to that of the destination type fails.

assert_eq!(
    Seconds::<u32>::try_from(Generic::new(u32::MAX as u64 + 1, Fraction::new(1,1))),
    Err(ConversionError::ConversionFailure)
);

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

type Error = ConversionError

The type returned in the event of a conversion error.

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

Construct a named Duration from a Generic Duration

Examples

assert_eq!(
    Seconds::<u64>::try_from(Generic::new(2_000_u32, Fraction::new(1, 1_000))),
    Ok(Seconds(2_u64))
);

// TryInto also works
assert_eq!(
    Generic::new(2_000_u64, Fraction::new(1, 1_000)).try_into(),
    Ok(Seconds(2_u64))
);

Errors

Failure will only occur if the provided value does not fit in the selected destination type.

---

ConversionError::Overflow : The conversion of the scaling factor causes an overflow.

assert_eq!(
    Seconds::<u32>::try_from(Generic::new(u32::MAX, Fraction::new(10,1))),
    Err(ConversionError::Overflow)
);

---

ConversionError::ConversionFailure : The integer conversion to that of the destination type fails.

assert_eq!(
    Seconds::<u32>::try_from(Generic::new(u32::MAX as u64 + 1, Fraction::new(1,1))),
    Err(ConversionError::ConversionFailure)
);