Struct embedded_time::duration::units::Milliseconds

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

A duration unit type

Trait Implementations

impl<T: TimeInt, Rhs: Duration> Add<Rhs> for Milliseconds<T> where
    Rhs: FixedPoint,
    T: TryFrom<Rhs::T>, 

type Output = Self

The resulting type after applying the + operator.

fn add(self, rhs: Rhs) -> Self::Output

Returns the sum as the LHS type

Examples

assert_eq!((Milliseconds(1_u32) + Seconds(1_u32)),
    Milliseconds(1_001_u32));

Panics

The same reason the integer operation would panic. Namely, if the result overflows the type.

let _ = Seconds(u32::MAX) + Seconds(1_u32);

impl<T: Clone + TimeInt> Clone for Milliseconds<T>

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

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

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

Formats the value using the given formatter.

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

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

Just forwards the underlying integer to core::fmt::Display::fmt()

assert_eq!(format!("{}", Seconds(123_u32)), "123");

impl<T: TimeInt> Duration for Milliseconds<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 + TimeInt> Eq for Milliseconds<T>

impl<T: Ord + TimeInt> Ord for Milliseconds<T>

fn cmp(&self, other: &Milliseconds<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, Rhs: Duration> PartialEq<Rhs> for Milliseconds<T> where
    T: TryFrom<Rhs::T>,
    Rhs: FixedPoint,
    Rhs::T: TryFrom<T>, 

fn eq(&self, rhs: &Rhs) -> bool

assert_eq!(Seconds(123_u32), Milliseconds(123_000_u64));
assert_ne!(Seconds(123_u32), Milliseconds(123_001_u64));

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

This method tests for !=.

impl<T: TimeInt, Rhs: Duration> PartialOrd<Rhs> for Milliseconds<T> where
    T: TryFrom<Rhs::T>,
    Rhs: FixedPoint,
    Rhs::T: TryFrom<T>, 

fn partial_cmp(&self, rhs: &Rhs) -> Option<Ordering>

assert!(Seconds(2_u64) < Milliseconds(2_001_u32));
assert!(Seconds(2_u32) > Milliseconds(1_999_u32));

#[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, Rhs: Duration> Rem<Rhs> for Milliseconds<T> where
    T: TryFrom<Rhs::T>,
    Rhs: FixedPoint, 

type Output = Self

The resulting type after applying the % operator.

fn rem(self, rhs: Rhs) -> Self::Output

Returns the remainder as the LHS type

assert_eq!(Minutes(62_u32) % Hours(1_u32), Minutes(2_u32));

impl<T: TimeInt> StructuralEq for Milliseconds<T>

impl<T: TimeInt, Rhs: Duration> Sub<Rhs> for Milliseconds<T> where
    T: TryFrom<Rhs::T>,
    Rhs: FixedPoint, 

type Output = Self

The resulting type after applying the - operator.

fn sub(self, rhs: Rhs) -> Self::Output

Returns the difference as the LHS type

Examples

assert_eq!((Milliseconds(2_001_u32) - Seconds(1_u32)),
    Milliseconds(1_001_u32));

Panics

The same reason the integer operation would panic. Namely, if the result overflows the type.

let _ = Seconds(0_u32) - Seconds(1_u32);

impl<T: TimeInt> TryFrom<Duration> for Milliseconds<T>

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(core_duration: Duration) -> Result<Self, Self::Error>

Construct an embedded_time::Duration from a core::time::Duration

Examples

let core_duration = core::time::Duration::new(5, 730023852);
assert_eq!(Milliseconds::<u32>::try_from(core_duration), Ok(5_730.milliseconds()));

let duration: Result<Milliseconds<u32>, _> =
    core::time::Duration::new(5, 730023852).try_into();
assert_eq!(duration, Ok(5_730.milliseconds()));

Errors

ConversionError::ConversionFailure : The result doesn't fit in the specified type

assert_eq!(
    Milliseconds::<u32>::try_from(core::time::Duration::from_millis((u32::MAX as u64) + 1)),
    Err(ConversionError::ConversionFailure)
);

let duration: Result<Milliseconds<u32>, _> =
    core::time::Duration::from_millis((u32::MAX as u64) + 1).try_into();
assert_eq!(duration, 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<T: TimeInt> TryFrom<Milliseconds<T>> for Duration

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(duration: Milliseconds<T>) -> Result<Self, Self::Error>

Construct a core::time::Duration from an embedded_time::Duration

let core_duration = core::time::Duration::try_from(2_569_u32.milliseconds()).unwrap();
assert_eq!(core_duration.as_secs(), 2);
assert_eq!(core_duration.subsec_nanos(), 569_000_000);

let core_duration: core::time::Duration = 2_569_u32.milliseconds().try_into().unwrap();
assert_eq!(core_duration.as_secs(), 2);
assert_eq!(core_duration.subsec_nanos(), 569_000_000);