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

//! Representations of frequency-based values

pub(crate) mod units {
    use crate::{ConversionError, Period, TimeInt};
    use core::{convert, ops};

    /// A frequency unit type
    ///
    /// Convertible to/from [`Period`].
    #[derive(Debug, Ord, PartialOrd, Eq, PartialEq)]
    pub struct Hertz<T: TimeInt = u32>(pub T);

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

        /// ```rust
        /// # use embedded_time::units::*;
        /// assert_eq!(Hertz(100_u32) * 3_u32, Hertz(300_u32));
        /// ```
        fn mul(self, rhs: Rhs) -> Self::Output {
            Self(self.0 * <T as convert::From<Rhs>>::from(rhs))
        }
    }

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

        /// ```rust
        /// # use embedded_time::units::*;
        /// assert_eq!(Hertz(300_u32) / 3_u32, Hertz(100_u32));
        /// ```
        fn div(self, rhs: Rhs) -> Self::Output {
            Self(self.0 / <T as convert::From<Rhs>>::from(rhs))
        }
    }

    impl<T: TimeInt> convert::TryFrom<Period<T>> for Hertz<T> {
        type Error = ConversionError;

        /// Create a new `Frequency` from a fractional [`Period`] in seconds
        ///
        /// # Examples
        ///
        /// ```rust
        /// # use embedded_time::{Period, units::*, ConversionError};
        /// # use core::{convert::{TryFrom, TryInto}};
        /// #
        /// assert_eq!(Hertz::try_from(<Period>::new(1, 1_000)),
        ///     Ok(Hertz(1_000_u32)));
        ///
        /// assert_eq!(Hertz::try_from(<Period>::new(0, 1_000)),
        ///     Err(ConversionError::DivByZero));
        ///
        /// assert_eq!(<Period>::new(1, 1_000).try_into(),
        ///     Ok(Hertz(1_000_u32)));
        /// ```
        ///
        /// # Errors
        ///
        /// [`ConversionError::DivByZero`]
        fn try_from(period: Period<T>) -> Result<Self, Self::Error> {
            if !period.numerator().is_zero() {
                Ok(Hertz(period.recip().to_integer()))
            } else {
                Err(ConversionError::DivByZero)
            }
        }
    }

    impl convert::From<u32> for Hertz {
        /// ```rust
        /// # use embedded_time::units::Hertz;
        /// #
        /// assert_eq!(Hertz::from(23), Hertz(23_u32));
        /// assert_eq!(<Hertz as Into<u32>>::into(Hertz(23_u32)), 23_u32);
        /// ```
        fn from(value: u32) -> Self {
            Self(value)
        }
    }

    impl convert::From<Hertz> for u32 {
        /// ```rust
        /// # use embedded_time::units::Hertz;
        /// #
        /// assert_eq!(u32::from(Hertz(23)), 23_u32);
        /// assert_eq!(<u32 as Into<Hertz>>::into(23), Hertz(23_u32));
        /// ```
        fn from(hertz: Hertz) -> Self {
            hertz.0
        }
    }
}