max/embassy
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add Struct/impl documentation for embassy::time::Duration

Browse Source
This commit is contained in:
Joshua Salzedo 2021-03-21 16:45:48 -07:00
parent cf1323fb67
commit d453b9dd95
1 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
embassy/src/time/duration.rs
View File

@ -26,16 +26,18 @@ impl Duration {
self.ticks * 1_000_000 / TICKS_PER_SECOND self.ticks * 1_000_000 / TICKS_PER_SECOND
} }
/// Creates a duration from the specified number of clock ticks
pub const fn from_ticks(ticks: u64) -> Duration { pub const fn from_ticks(ticks: u64) -> Duration {
Duration { ticks } Duration { ticks }
} }
/// Creates a duration from the specified number of seconds
pub const fn from_secs(secs: u64) -> Duration { pub const fn from_secs(secs: u64) -> Duration {
Duration { Duration {
ticks: secs * TICKS_PER_SECOND, ticks: secs * TICKS_PER_SECOND,
} }
} }
/// Creates a duration from the specified number of milliseconds
pub const fn from_millis(millis: u64) -> Duration { pub const fn from_millis(millis: u64) -> Duration {
Duration { Duration {
ticks: millis * TICKS_PER_SECOND / 1000, ticks: millis * TICKS_PER_SECOND / 1000,
@ -45,30 +47,34 @@ impl Duration {
/* /*
NOTE: us delays may not be as accurate NOTE: us delays may not be as accurate
*/ */
/// Creates a duration from the specified number of microseconds
/// NOTE: Delays this small may be inaccurate.
pub const fn from_micros(micros: u64) -> Duration { pub const fn from_micros(micros: u64) -> Duration {
Duration { Duration {
ticks: micros * TICKS_PER_SECOND / 1_000_000, ticks: micros * TICKS_PER_SECOND / 1_000_000,
} }
} }
/// Adds one Duration to another, returning a new Duration or None in the event of an overflow.
pub fn checked_add(self, rhs: Duration) -> Option<Duration> { pub fn checked_add(self, rhs: Duration) -> Option<Duration> {
self.ticks self.ticks
.checked_add(rhs.ticks) .checked_add(rhs.ticks)
.map(|ticks| Duration { ticks }) .map(|ticks| Duration { ticks })
} }
/// Subtracts one Duration to another, returning a new Duration or None in the event of an overflow.
pub fn checked_sub(self, rhs: Duration) -> Option<Duration> { pub fn checked_sub(self, rhs: Duration) -> Option<Duration> {
self.ticks self.ticks
.checked_sub(rhs.ticks) .checked_sub(rhs.ticks)
.map(|ticks| Duration { ticks }) .map(|ticks| Duration { ticks })
} }
/// Multiplies one Duration to another, returning a new Duration or None in the event of an overflow.
pub fn checked_mul(self, rhs: u32) -> Option<Duration> { pub fn checked_mul(self, rhs: u32) -> Option<Duration> {
self.ticks self.ticks
.checked_mul(rhs as _) .checked_mul(rhs as _)
.map(|ticks| Duration { ticks }) .map(|ticks| Duration { ticks })
} }
/// Divides one Duration against another, returning a new Duration or None in the event of an overflow.
pub fn checked_div(self, rhs: u32) -> Option<Duration> { pub fn checked_div(self, rhs: u32) -> Option<Duration> {
self.ticks self.ticks
.checked_div(rhs as _) .checked_div(rhs as _)