Struct MockClock 

pub struct MockClock { /* private fields */ }

A controllable clock implementation for testing.

MockClock allows you to manually control the passage of time, making it ideal for testing time-dependent code. It uses MonotonicClock as its internal time base to ensure stability during tests.

Features

• Set the clock to a specific time
• Advance the clock by a duration
• Automatically advance time on each call
• Reset to initial state

Thread Safety

This type is thread-safe, using Arc<Mutex<>> internally to protect its mutable state.

Examples

use prism3_clock::{Clock, ControllableClock, MockClock};
use chrono::{DateTime, Duration, Utc};

let clock = MockClock::new();

// Set to a specific time
let fixed_time = DateTime::parse_from_rfc3339(
    "2024-01-01T00:00:00Z"
).unwrap().with_timezone(&Utc);
clock.set_time(fixed_time);
assert_eq!(clock.time(), fixed_time);

// Advance by 1 hour
clock.add_duration(Duration::hours(1));
assert_eq!(clock.time(), fixed_time + Duration::hours(1));

// Reset to initial state
clock.reset();

Author

Haixing Hu

Implementations

impl MockClock

pub fn new() -> Self

Creates a new MockClock.

The clock is initialized with the current system time and uses a MonotonicClock as its internal time base.

Returns

A new MockClock instance.

Examples

use prism3_clock::MockClock;

let clock = MockClock::new();

pub fn add_millis(&self, millis: i64, add_every_time: bool)

Adds a fixed amount of milliseconds to the clock.

Arguments

• millis - The number of milliseconds to add.
• add_every_time - If true, the specified milliseconds will be added on every call to millis(). If false, the milliseconds are added only once.

Examples

use prism3_clock::{Clock, MockClock};

let clock = MockClock::new();
let before = clock.millis();

// Add 1000ms once
clock.add_millis(1000, false);
assert_eq!(clock.millis(), before + 1000);

// Add 100ms on every call
clock.add_millis(100, true);
let t1 = clock.millis();
let t2 = clock.millis();
assert_eq!(t2 - t1, 100);

Trait Implementations

impl Clock for MockClock

fn millis(&self) -> i64

Returns the current time as a Unix timestamp in milliseconds (UTC).

fn time(&self) -> DateTime<Utc>

Returns the current time as a DateTime<Utc>.

impl Clone for MockClock

fn clone(&self) -> MockClock

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ControllableClock for MockClock

fn set_time(&self, instant: DateTime<Utc>)

Sets the clock to a specific time.

fn add_duration(&self, duration: Duration)

Advances the clock by the specified duration.

fn reset(&self)

Resets the clock to its initial state.

impl Debug for MockClock

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

Formats the value using the given formatter.

impl Default for MockClock

fn default() -> Self

Returns the “default value” for a type.