Struct embedded_time::Period

pub struct Period<T = i32>(_);

A fractional time period

Used primarily to define the period of one count of a crate::Duration type

Implementations

impl<T> Period<T>

pub const fn new(numerator: T, denominator: T) -> Self

Construct a new fractional Period.

A reduction is not performed.

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

Return the numerator of the fraction

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

Return the denominator of the fraction

impl<T: TimeInt> Period<T>

pub fn new_reduce(numerator: T, denominator: T) -> Self

Construct a new fractional Period.

A reduction is performed.

pub fn to_frequency(&self) -> Hertz<T>

Returns a frequency in Hertz from the Period

pub fn from_frequency(freq: Hertz<T>) -> Self

Constructs a Period from a frequency in Hertz

pub fn to_integer(&self) -> T

Returns an integer approximation of the Period

Any remainder is truncated.

pub fn from_integer(value: T) -> Self

Constructs a Period from an integer.

Equivalent to Period::new(value,1).

pub fn checked_mul_integer(&self, multiplier: T) -> Option<Self>

assert_eq!(Period::new(1000, 1).checked_mul_integer(5), Some(Period::new(5_000, 1)));

assert_eq!(Period::new(i32::MAX, 1).checked_mul_integer(2), None);

pub fn checked_div_integer(&self, divisor: T) -> Option<Self>

assert_eq!(Period::new(1000, 1).checked_div_integer(5), Some(Period::new(200, 1)));
assert_eq!(Period::new(1, 1000).checked_div_integer(5), Some(Period::new(1, 5000)));

assert_eq!(Period::new(1, i32::MAX).checked_div_integer(2), None);

Trait Implementations

impl<T> CheckedDiv for Period<T> where
    T: TimeInt, 

fn checked_div(&self, v: &Self) -> Option<Self>

assert_eq!(<Period as num::CheckedDiv>::checked_div(&Period::new(1000, 1),
    &Period::new(10, 1000)), Some(Period::new(1_000_000, 10)));

assert_eq!(<Period as num::CheckedDiv>::checked_div(&Period::new(1, i32::MAX),
    &Period::new(2,1)), None);

impl<T> CheckedMul for Period<T> where
    T: TimeInt, 

fn checked_mul(&self, v: &Self) -> Option<Self>

assert_eq!(<Period as num::CheckedMul>::checked_mul(&Period::new(1000, 1),
    &Period::new(5,5)), Some(Period::new(5_000, 5)));

assert_eq!(<Period as num::CheckedMul>::checked_mul(&Period::new(i32::MAX, 1),
    &Period::new(2,1)), None);

impl<T: Debug> Debug for Period<T>

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

Formats the value using the given formatter.

impl<T> Div<Period<T>> for Period<T> where
    T: TimeInt, 

type Output = Self

The resulting type after applying the / operator.

fn div(self, rhs: Self) -> Self::Output

assert_eq!(Period::new(1000, 1) / Period::new(10, 1_000),
    Period::new(1_000_000, 10));

impl<T> Mul<Period<T>> for Period<T> where
    T: TimeInt, 

type Output = Self

The resulting type after applying the * operator.

fn mul(self, rhs: Self) -> Self::Output

assert_eq!(Period::new(1000, 1) * Period::new(5,5),
    Period::new(5_000, 5));

impl<T: TimeInt> PartialEq<Period<T>> for Period<T>

fn eq(&self, other: &Self) -> bool

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

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

This method tests for !=.

impl<T: TimeInt> PartialOrd<Period<T>> for Period<T>

fn partial_cmp(&self, other: &Self) -> 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.