SimClock

Struct SimClock 

Source
pub struct SimClock { /* private fields */ }
Expand description

A simulated clock for deterministic testing.

TigerStyle:

  • Time only moves forward
  • All time operations are explicit
  • No reliance on system time
  • Supports async sleep with notify for coordination

Thread-safe via Arc for current time.

Implementations§

Source§

impl SimClock

Source

pub fn new() -> Self

Create a new clock starting at time zero.

§Example
use umi_memory::dst::SimClock;
let clock = SimClock::new();
assert_eq!(clock.now_ms(), 0);
Source

pub fn at_ms(start_ms: u64) -> Self

Create a clock starting at the given millisecond timestamp.

Source

pub fn at_datetime(dt: DateTime<Utc>) -> Self

Create a clock starting at the given DateTime.

Source

pub fn from_epoch() -> Self

Create a clock starting at Unix epoch (1970-01-01).

Source

pub fn now_ms(&self) -> u64

Get current time in milliseconds.

Source

pub fn now_secs(&self) -> u64

Get current time in seconds (truncated).

Source

pub fn now(&self) -> DateTime<Utc>

Get current time as DateTime.

Source

pub fn advance_ms(&self, ms: u64) -> u64

Advance time by the given milliseconds.

§Panics

Panics if ms exceeds DST_TIME_ADVANCE_MS_MAX.

§Returns

The new current time.

Source

pub fn advance_secs(&self, secs: f64) -> u64

Advance time by the given seconds.

§Panics

Panics if resulting ms exceeds DST_TIME_ADVANCE_MS_MAX.

Source

pub fn advance(&self, duration: Duration)

Advance time by a chrono Duration.

Source

pub fn set_ms(&self, ms: u64)

Set time to absolute value.

§Panics

Panics if new time is less than current time.

Source

pub fn set(&self, time: DateTime<Utc>)

Set time to a DateTime.

Source

pub fn elapsed_since(&self, since: u64) -> u64

Get elapsed time since a given timestamp.

§Panics

Panics if since is in the future.

Source

pub fn has_elapsed(&self, since: u64, duration_ms: u64) -> bool

Check if a given duration has elapsed since a timestamp.

Source

pub fn is_past_ms(&self, deadline_ms: u64) -> bool

Check if a deadline (in ms) has passed.

Source

pub fn is_past(&self, deadline: DateTime<Utc>) -> bool

Check if a DateTime deadline has passed.

Source

pub fn timestamp(&self) -> u64

Get a timestamp that represents “now” for storing.

Source

pub async fn sleep_ms(&self, duration_ms: u64)

Sleep until the specified duration has passed.

In simulation mode, this yields and waits for time to be advanced. Returns when current_time >= start_time + duration_ms.

Source

pub async fn sleep(&self, duration: Duration)

Sleep for a chrono Duration.

Source

pub async fn sleep_until_ms(&self, deadline_ms: u64)

Sleep until a specific deadline.

Trait Implementations§

Source§

impl Clone for SimClock

Source§

fn clone(&self) -> SimClock

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for SimClock

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for SimClock

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more