quanta/mock.rs
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
use crossbeam_utils::atomic::AtomicCell;
use std::{sync::Arc, time::Duration};
/// Type which can be converted into a nanosecond representation.
///
/// This allows users of [`Mock`] to increment/decrement the time both with raw
/// integer values and the more convenient [`Duration`] type.
pub trait IntoNanoseconds {
/// Consumes this value, converting it to a nanosecond representation.
fn into_nanos(self) -> u64;
}
impl IntoNanoseconds for u64 {
fn into_nanos(self) -> u64 {
self
}
}
impl IntoNanoseconds for Duration {
fn into_nanos(self) -> u64 {
self.as_nanos() as u64
}
}
/// Controllable time source for use in tests.
///
/// A mocked clock allows the caller to adjust the given time backwards and forwards by whatever
/// amount they choose. While [`Clock`](crate::Clock) promises monotonic values for normal readings,
/// when running in mocked mode, these guarantees do not apply: the given `Clock`/`Mock` pair are
/// directly coupled.
///
/// This can be useful for not only testing code that depends on the passage of time, but also for
/// testing that code can handle large shifts in time.
#[derive(Debug, Clone)]
pub struct Mock {
offset: Arc<AtomicCell<u64>>,
}
impl Mock {
pub(crate) fn new() -> Self {
Self {
offset: Arc::new(AtomicCell::new(0)),
}
}
/// Increments the time by the given amount.
pub fn increment<N: IntoNanoseconds>(&self, amount: N) {
let amount = amount.into_nanos();
self.offset
.fetch_update(|current| Some(current + amount))
.expect("should never return an error");
}
/// Decrements the time by the given amount.
pub fn decrement<N: IntoNanoseconds>(&self, amount: N) {
let amount = amount.into_nanos();
self.offset
.fetch_update(|current| Some(current - amount))
.expect("should never return an error");
}
/// Gets the current value of this `Mock`.
pub fn value(&self) -> u64 {
self.offset.load()
}
}