1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149

use crate::frequency::units::Hertz;
use crate::TimeInt;
use core::{cmp, ops};
use num::rational::Ratio;
use num::{CheckedDiv, CheckedMul};

#[derive(Debug)]
pub struct Period<T = i32>(Ratio<T>);

impl<T> Period<T> {
    pub const fn new(numerator: T, denominator: T) -> Self {
        Self(Ratio::new_raw(numerator, denominator))
    }

    pub const fn numerator(&self) -> &T {
        self.0.numer()
    }

    pub const fn denominator(&self) -> &T {
        self.0.denom()
    }
}

impl<T: TimeInt> Period<T> {
    pub fn new_reduce(numerator: T, denominator: T) -> Self {
        Self(Ratio::new(numerator, denominator))
    }

    pub fn to_frequency(&self) -> Hertz<T> {
        Hertz(self.0.recip().to_integer())
    }

    pub fn from_frequency(freq: Hertz<T>) -> Self {
        Self(Ratio::from_integer(freq.0).recip())
    }

    pub fn to_integer(&self) -> T {
        self.0.to_integer()
    }

    pub fn from_integer(value: T) -> Self {
        Self(Ratio::from_integer(value))
    }

    /// ```rust
    /// # use embedded_time::Period;
    /// 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_mul_integer(&self, multiplier: T) -> Option<Self> {
        Some(Self(Ratio::checked_mul(
            &self.0,
            &Ratio::from_integer(multiplier),
        )?))
    }

    /// ```rust
    /// # use embedded_time::Period;
    /// 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);
    /// ```
    pub fn checked_div_integer(&self, divisor: T) -> Option<Self> {
        Some(Self(Ratio::checked_div(
            &self.0,
            &Ratio::from_integer(divisor),
        )?))
    }
}

impl<T> ops::Mul for Period<T>
where
    T: TimeInt,
{
    type Output = Self;

    /// ```rust
    /// # use embedded_time::Period;
    /// assert_eq!(Period::new(1000, 1) * Period::new(5,5),
    ///     Period::new(5_000, 5));
    /// ```
    fn mul(self, rhs: Self) -> Self::Output {
        Self(self.0 * rhs.0)
    }
}

impl<T> num::CheckedMul for Period<T>
where
    T: TimeInt,
{
    /// ```rust
    /// # use embedded_time::Period;
    /// 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);
    /// ```
    fn checked_mul(&self, v: &Self) -> Option<Self> {
        Some(Self(self.0.checked_mul(&v.0)?))
    }
}

impl<T> ops::Div for Period<T>
where
    T: TimeInt,
{
    type Output = Self;

    /// ```rust
    /// # use embedded_time::Period;
    /// assert_eq!(Period::new(1000, 1) / Period::new(10, 1_000),
    ///     Period::new(1_000_000, 10));
    /// ```
    fn div(self, rhs: Self) -> Self::Output {
        Self(self.0 / rhs.0)
    }
}

impl<T> num::CheckedDiv for Period<T>
where
    T: TimeInt,
{
    /// ```rust
    /// # use embedded_time::Period;
    /// 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);
    /// ```
    fn checked_div(&self, v: &Self) -> Option<Self> {
        Some(Self(self.0.checked_div(&v.0)?))
    }
}

impl<T: TimeInt> PartialOrd for Period<T> {
    fn partial_cmp(&self, other: &Self) -> Option<cmp::Ordering> {
        self.0.partial_cmp(&other.0)
    }
}

impl<T: TimeInt> PartialEq for Period<T> {
    fn eq(&self, other: &Self) -> bool {
        self.0 == other.0
    }
}