qubit-clock 0.13.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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73

// =============================================================================
//    Copyright (c) 2025 - 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0.
// =============================================================================
//! Defines the notification latch used by a blocking sleeper.

use std::sync::Arc;
use std::task::Wake;

use super::notification_latch::NotificationLatch;

/// Thread notification latch used as a future waker.
pub(crate) struct ThreadWaker {
    /// Thread parked while its timer future remains pending.
    thread: std::thread::Thread,
    /// Notification bit preventing wake-before-park races.
    notification: NotificationLatch,
}

impl ThreadWaker {
    /// Creates a notification latch for `thread`.
    ///
    /// # Parameters
    ///
    /// * `thread` - Thread to unpark after a notification is latched.
    ///
    /// # Returns
    ///
    /// A latch with no pending notification.
    #[must_use]
    #[inline(always)]
    pub(crate) fn new(thread: std::thread::Thread) -> Self {
        Self {
            thread,
            notification: NotificationLatch::new(),
        }
    }

    /// Clears a stale notification before polling the future again.
    #[inline(always)]
    pub(crate) fn clear_notification(&self) {
        self.notification.clear_notification();
    }

    /// Takes and clears the currently latched notification.
    ///
    /// # Returns
    ///
    /// `true` when a wake occurred since the previous clear or take.
    #[must_use]
    #[inline(always)]
    pub(crate) fn take_notification(&self) -> bool {
        self.notification.take_notification()
    }
}

impl Wake for ThreadWaker {
    /// Latches a notification before unparking the blocked thread.
    #[inline(always)]
    fn wake(self: Arc<Self>) {
        self.wake_by_ref();
    }

    /// Latches a notification before unparking the blocked thread.
    #[inline(always)]
    fn wake_by_ref(self: &Arc<Self>) {
        self.notification.notify();
        self.thread.unpark();
    }
}