Skip to content

Commit 6212c61

Browse files
committed
time: fix duration variable names, add doc
1 parent 9ae512e commit 6212c61

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

src/time.rs

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,16 +101,18 @@ impl U32Ext for u32 {
101101
}
102102
}
103103

104+
/// Converts clock cycles at a given frequency into a Duration with arbitrary fraction
104105
pub fn duration<const NOM: u32, const DENOM: u32>(
105106
hz: Hertz,
106107
cycles: u32,
107108
) -> Duration<u32, NOM, DENOM> {
108109
let cycles = cycles as u64;
109110
let clk = hz.raw() as u64;
110-
let us = cycles.saturating_mul(DENOM as u64) / clk / NOM as u64;
111-
Duration::<u32, NOM, DENOM>::from_ticks(us as u32)
111+
let duration_ticks = cycles.saturating_mul(DENOM as u64) / clk / NOM as u64;
112+
Duration::<u32, NOM, DENOM>::from_ticks(duration_ticks as u32)
112113
}
113114

115+
/// Converts a Duration with arbitrary fraction into a number of cycles at the specified frequency
114116
pub fn cycles<const NOM: u32, const DENOM: u32>(ms: Duration<u32, NOM, DENOM>, clk: Hertz) -> u32 {
115117
assert!(ms.ticks() > 0);
116118
let clk = clk.raw() as u64;

0 commit comments

Comments
 (0)