qubit-clock 0.11.0

Injectable wall and monotonic clocks with deterministic timers
Documentation 
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

// =============================================================================
//    Copyright (c) 2025 - 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0.
// =============================================================================
//! Defines an immutable fixed wall clock.

use crate::WallClock;
use std::time::SystemTime;

/// A wall clock that always returns one fixed time.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct FixedWallClock {
    /// Immutable wall-clock value returned by every sample.
    fixed_time: SystemTime,
}

impl FixedWallClock {
    /// Creates a clock that always returns `fixed_time`.
    ///
    /// # Parameters
    ///
    /// * `fixed_time` - Wall-clock value returned by every sample.
    ///
    /// # Returns
    ///
    /// A wall clock fixed at `fixed_time`.
    #[must_use]
    pub const fn new(fixed_time: SystemTime) -> Self {
        Self { fixed_time }
    }

    /// Returns the immutable time held by this clock.
    ///
    /// # Returns
    ///
    /// The configured fixed wall-clock value.
    #[must_use]
    pub const fn fixed_time(&self) -> SystemTime {
        self.fixed_time
    }
}

impl WallClock for FixedWallClock {
    /// Returns the configured fixed wall time.
    ///
    /// # Returns
    ///
    /// The same fixed value for every call.
    fn now(&self) -> SystemTime {
        self.fixed_time
    }
}