eyeball/
state.rs

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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
use std::{
    hash::{Hash, Hasher},
    mem,
    sync::RwLock,
    task::{Context, Poll, Waker},
};

#[derive(Debug)]
pub struct ObservableState<T> {
    /// The wrapped value.
    value: T,

    /// The attached observable metadata.
    metadata: RwLock<ObservableStateMetadata>,
}

#[derive(Debug)]
struct ObservableStateMetadata {
    /// The version of the value.
    ///
    /// Starts at 1 and is incremented by 1 each time the value is updated.
    /// When the observable is dropped, this is set to 0 to indicate no further
    /// updates will happen.
    version: u64,

    /// List of wakers.
    ///
    /// This is part of `ObservableState` and uses extra locking so that it is
    /// guaranteed that it's only updated by subscribers while the value is
    /// locked for reading. This way, it is guaranteed that between a subscriber
    /// reading the value and adding a waker because the value hasn't changed
    /// yet, no updates to the value could have happened.
    wakers: Vec<Waker>,
}

impl Default for ObservableStateMetadata {
    fn default() -> Self {
        Self { version: 1, wakers: Vec::new() }
    }
}

impl<T> ObservableState<T> {
    pub(crate) fn new(value: T) -> Self {
        Self { value, metadata: Default::default() }
    }

    /// Get a reference to the inner value.
    pub(crate) fn get(&self) -> &T {
        &self.value
    }

    /// Get the current version of the inner value.
    pub(crate) fn version(&self) -> u64 {
        self.metadata.read().unwrap().version
    }

    pub(crate) fn poll_update(
        &self,
        observed_version: &mut u64,
        cx: &Context<'_>,
    ) -> Poll<Option<()>> {
        let mut metadata = self.metadata.write().unwrap();

        if metadata.version == 0 {
            Poll::Ready(None)
        } else if *observed_version < metadata.version {
            *observed_version = metadata.version;
            Poll::Ready(Some(()))
        } else {
            metadata.wakers.push(cx.waker().clone());
            Poll::Pending
        }
    }

    pub(crate) fn set(&mut self, value: T) -> T {
        let result = mem::replace(&mut self.value, value);
        self.incr_version_and_wake();
        result
    }

    pub(crate) fn set_if_not_eq(&mut self, value: T) -> Option<T>
    where
        T: PartialEq,
    {
        if self.value != value {
            Some(self.set(value))
        } else {
            None
        }
    }

    pub(crate) fn set_if_hash_not_eq(&mut self, value: T) -> Option<T>
    where
        T: Hash,
    {
        if hash(&self.value) != hash(&value) {
            Some(self.set(value))
        } else {
            None
        }
    }

    pub(crate) fn update(&mut self, f: impl FnOnce(&mut T)) {
        f(&mut self.value);
        self.incr_version_and_wake();
    }

    pub(crate) fn update_if(&mut self, f: impl FnOnce(&mut T) -> bool) {
        if f(&mut self.value) {
            self.incr_version_and_wake();
        }
    }

    /// "Close" the state – indicate that no further updates will happen.
    pub(crate) fn close(&self) {
        let mut metadata = self.metadata.write().unwrap();
        metadata.version = 0;
        // Clear the backing buffer for the wakers, no new ones will be added.
        wake(mem::take(&mut metadata.wakers));
    }

    fn incr_version_and_wake(&mut self) {
        let metadata = self.metadata.get_mut().unwrap();
        metadata.version += 1;
        wake(metadata.wakers.drain(..));
    }
}

fn hash<T: Hash>(value: &T) -> u64 {
    use std::collections::hash_map::DefaultHasher;

    let mut hasher = DefaultHasher::new();
    value.hash(&mut hasher);
    hasher.finish()
}

fn wake<I>(wakers: I)
where
    I: IntoIterator<Item = Waker>,
    I::IntoIter: ExactSizeIterator,
{
    let iter = wakers.into_iter();
    #[cfg(feature = "tracing")]
    {
        let num_wakers = iter.len();
        if num_wakers > 0 {
            tracing::debug!("Waking up {num_wakers} waiting subscribers");
        } else {
            tracing::debug!("No wakers");
        }
    }
    for waker in iter {
        waker.wake();
    }
}