qubit-clock 0.12.1

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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141

// =============================================================================
//    Copyright (c) 2025 - 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0.
// =============================================================================

use qubit_clock::{
    BlockingSleeper,
    ManualMonotonicClock,
    MonotonicClock,
    MonotonicInstant,
    StdMonotonicClock,
    TimeError,
    Timer,
    TimerFuture,
    TimerUnavailableError,
};
use std::io;
use std::sync::Arc;
use std::thread;
use std::time::Duration;

#[test]
fn test_blocking_sleeper_uses_manual_timer_without_real_delay() {
    let clock = ManualMonotonicClock::new_shared();
    let sleeper = BlockingSleeper::new(clock.new_timer());
    let worker =
        thread::spawn(move || sleeper.sleep_for(Duration::from_secs(16)));

    assert!(clock.wait_for_waiters(1, Duration::from_secs(1)));
    let _reached = clock
        .advance_to_next_deadline()
        .expect("blocking deadline should exist");
    worker
        .join()
        .expect("blocking worker should finish")
        .expect("blocking sleep should succeed");
}

#[test]
fn test_blocking_sleeper_uses_standard_timer() {
    let clock = StdMonotonicClock::new();
    let sleeper = BlockingSleeper::new(clock.new_timer());

    sleeper
        .sleep_for(Duration::from_millis(2))
        .expect("standard timer should complete");
}

#[test]
fn test_blocking_sleeper_exposes_composed_timer() {
    let clock = ManualMonotonicClock::new();
    let sleeper = BlockingSleeper::new(clock.new_timer());
    let cloned = sleeper.clone();

    assert_eq!(clock.now().domain(), sleeper.timer().clock().now().domain(),);
    assert_eq!(clock.now().domain(), cloned.timer().clock().now().domain(),);
    assert!(format!("{sleeper:?}").starts_with("BlockingSleeper"));
}

struct CompletionFailingTimer {
    clock: ManualMonotonicClock,
}

impl Timer for CompletionFailingTimer {
    fn clock(&self) -> &dyn MonotonicClock {
        &self.clock
    }

    fn at(
        &self,
        _deadline: MonotonicInstant,
    ) -> Result<TimerFuture, TimeError> {
        Ok(Box::pin(std::future::ready(Err(
            TimeError::TimerUnavailable {
                source: TimerUnavailableError::BackendUnavailable {
                    backend: "test",
                    source: Box::new(io::Error::other(
                        "test timer completion failed",
                    )),
                },
            },
        ))))
    }
}

#[test]
fn test_blocking_sleeper_returns_completion_error() {
    let clock = ManualMonotonicClock::new();
    let sleeper =
        BlockingSleeper::new(Arc::new(CompletionFailingTimer { clock }));

    let Err(TimeError::TimerUnavailable {
        source: TimerUnavailableError::BackendUnavailable { backend, source },
    }) = sleeper.sleep_for(Duration::from_secs(1))
    else {
        panic!("failing timer should report completion failure");
    };
    assert_eq!("test", backend);
    assert_eq!("test timer completion failed", source.to_string());
}

struct FailingTimer {
    clock: ManualMonotonicClock,
}

impl Timer for FailingTimer {
    fn clock(&self) -> &dyn MonotonicClock {
        &self.clock
    }

    fn at(
        &self,
        _deadline: MonotonicInstant,
    ) -> Result<TimerFuture, TimeError> {
        Err(TimeError::TimerUnavailable {
            source: TimerUnavailableError::BackendUnavailable {
                backend: "test",
                source: Box::new(io::Error::other("test backend unavailable")),
            },
        })
    }
}

#[test]
fn test_blocking_sleeper_returns_registration_error_without_parking() {
    let clock = ManualMonotonicClock::new();
    let deadline = clock.now();
    let sleeper = BlockingSleeper::new(Arc::new(FailingTimer { clock }));

    let Err(TimeError::TimerUnavailable {
        source: TimerUnavailableError::BackendUnavailable { backend, source },
    }) = sleeper.sleep_until(deadline)
    else {
        panic!("failing timer should report backend unavailability");
    };
    assert_eq!("test", backend);
    assert_eq!("test backend unavailable", source.to_string());
}