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 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304
//! This module defines a unique [`Observable`] type that requires `&mut` access
//! to update its inner value but can be dereferenced (immutably).
//!
//! Use this in situations where only a single location in the code should be
//! able to update the inner value.
use std::{fmt, hash::Hash, mem, ops, ptr};
use readlock::Shared;
#[cfg(feature = "async-lock")]
use readlock_tokio::Shared as SharedAsync;
#[cfg(feature = "async-lock")]
use crate::AsyncLock;
use crate::{lock::Lock, shared::SharedObservable, state::ObservableState, Subscriber, SyncLock};
/// A value whose changes will be broadcast to subscribers.
///
/// `Observable<T>` dereferences to `T`, and does not have methods of its own to
/// not clash with methods of the inner type. Instead, to interact with the
/// `Observable` itself rather than the inner value, use its associated
/// functions (e.g. `Observable::subscribe(observable)`).
///
/// # Async-aware locking
///
/// Contrary to [`SharedObservable`]'s async-aware locking support, using
/// `Observable` with `L` = [`AsyncLock`] with this type is rarely useful since
/// having access to the `Observable` means nobody can be mutating the inner
/// value in parallel. It allows a subscriber to read-lock the value over a
/// `.await` point without losing `Send`-ness of the future though.
pub struct Observable<T, L: Lock = SyncLock> {
state: L::Shared<ObservableState<T>>,
}
impl<T> Observable<T> {
/// Create a new `Observable` with the given initial value.
#[must_use]
pub fn new(value: T) -> Self {
let state = Shared::new(ObservableState::new(value));
Self::from_inner(state)
}
/// Obtain a new subscriber.
///
/// Calling `.next().await` or `.next_ref().await` on the returned
/// subscriber only resolves once the inner value has been updated again
/// after the call to `subscribe`.
///
/// See [`subscribe_reset`][Self::subscribe_reset] if you want to obtain a
/// subscriber that immediately yields without any updates.
pub fn subscribe(this: &Self) -> Subscriber<T> {
Subscriber::new(Shared::get_read_lock(&this.state), this.state.version())
}
/// Obtain a new subscriber that immediately yields.
///
/// `.subscribe_reset()` is equivalent to `.subscribe()` with a subsequent
/// call to [`.reset()`][Subscriber::reset] on the returned subscriber.
///
/// In contrast to [`subscribe`][Self::subscribe], calling `.next().await`
/// or `.next_ref().await` on the returned subscriber before updating the
/// inner value yields the current value instead of waiting. Further calls
/// to either of the two will wait for updates.
pub fn subscribe_reset(this: &Self) -> Subscriber<T> {
Subscriber::new(Shared::get_read_lock(&this.state), 0)
}
/// Get a reference to the inner value.
///
/// Usually, you don't need to call this function since `Observable<T>`
/// implements `Deref`. Use this if you want to pass the inner value to a
/// generic function where the compiler can't infer that you want to have
/// the `Observable` dereferenced otherwise.
pub fn get(this: &Self) -> &T {
this.state.get()
}
/// Set the inner value to the given `value`, notify subscribers and return
/// the previous value.
pub fn set(this: &mut Self, value: T) -> T {
Shared::lock(&mut this.state).set(value)
}
/// Set the inner value to the given `value` if it doesn't compare equal to
/// the existing value.
///
/// If the inner value is set, subscribers are notified and
/// `Some(previous_value)` is returned. Otherwise, `None` is returned.
pub fn set_if_not_eq(this: &mut Self, value: T) -> Option<T>
where
T: PartialEq,
{
Shared::lock(&mut this.state).set_if_not_eq(value)
}
/// Set the inner value to the given `value` if it has a different hash than
/// the existing value.
///
/// If the inner value is set, subscribers are notified and
/// `Some(previous_value)` is returned. Otherwise, `None` is returned.
pub fn set_if_hash_not_eq(this: &mut Self, value: T) -> Option<T>
where
T: Hash,
{
Shared::lock(&mut this.state).set_if_hash_not_eq(value)
}
/// Set the inner value to a `Default` instance of its type, notify
/// subscribers and return the previous value.
///
/// Shorthand for `Observable::set(this, T::default())`.
pub fn take(this: &mut Self) -> T
where
T: Default,
{
Self::set(this, T::default())
}
/// Update the inner value and notify subscribers.
///
/// Note that even if the inner value is not actually changed by the
/// closure, subscribers will be notified as if it was. Use
/// [`update_if`][Self::update_if] if you want to conditionally mutate the
/// inner value.
pub fn update(this: &mut Self, f: impl FnOnce(&mut T)) {
Shared::lock(&mut this.state).update(f);
}
/// Maybe update the inner value and notify subscribers if it changed.
///
/// The closure given to this function must return `true` if subscribers
/// should be notified of a change to the inner value.
pub fn update_if(this: &mut Self, f: impl FnOnce(&mut T) -> bool) {
Shared::lock(&mut this.state).update_if(f);
}
}
#[cfg(feature = "async-lock")]
impl<T: Send + Sync + 'static> Observable<T, AsyncLock> {
/// Create a new `Observable` with the given initial value.
#[must_use]
pub fn new_async(value: T) -> Self {
let state = SharedAsync::new(ObservableState::new(value));
Self::from_inner(state)
}
/// Obtain a new subscriber.
///
/// Calling `.next().await` or `.next_ref().await` on the returned
/// subscriber only resolves once the inner value has been updated again
/// after the call to `subscribe`.
///
/// See [`subscribe_reset`][Self::subscribe_reset] if you want to obtain a
/// subscriber that immediately yields without any updates.
pub fn subscribe_async(this: &Self) -> Subscriber<T, AsyncLock> {
Subscriber::new_async(SharedAsync::get_read_lock(&this.state), this.state.version())
}
/// Obtain a new subscriber that immediately yields.
///
/// `.subscribe_reset()` is equivalent to `.subscribe()` with a subsequent
/// call to [`.reset()`][Subscriber::reset] on the returned subscriber.
///
/// In contrast to [`subscribe`][Self::subscribe], calling `.next().await`
/// or `.next_ref().await` on the returned subscriber before updating the
/// inner value yields the current value instead of waiting. Further calls
/// to either of the two will wait for updates.
pub fn subscribe_reset_async(this: &Self) -> Subscriber<T, AsyncLock> {
Subscriber::new_async(SharedAsync::get_read_lock(&this.state), 0)
}
/// Get a reference to the inner value.
///
/// Usually, you don't need to call this function since `Observable<T>`
/// implements `Deref`. Use this if you want to pass the inner value to a
/// generic function where the compiler can't infer that you want to have
/// the `Observable` dereferenced otherwise.
pub fn get_async(this: &Self) -> &T {
this.state.get()
}
/// Set the inner value to the given `value`, notify subscribers and return
/// the previous value.
pub async fn set_async(this: &mut Self, value: T) -> T {
SharedAsync::lock(&mut this.state).await.set(value)
}
/// Set the inner value to the given `value` if it doesn't compare equal to
/// the existing value.
///
/// If the inner value is set, subscribers are notified and
/// `Some(previous_value)` is returned. Otherwise, `None` is returned.
pub async fn set_if_not_eq_async(this: &mut Self, value: T) -> Option<T>
where
T: PartialEq,
{
SharedAsync::lock(&mut this.state).await.set_if_not_eq(value)
}
/// Set the inner value to the given `value` if it has a different hash than
/// the existing value.
///
/// If the inner value is set, subscribers are notified and
/// `Some(previous_value)` is returned. Otherwise, `None` is returned.
pub async fn set_if_hash_not_eq_async(this: &mut Self, value: T) -> Option<T>
where
T: Hash,
{
SharedAsync::lock(&mut this.state).await.set_if_hash_not_eq(value)
}
/// Set the inner value to a `Default` instance of its type, notify
/// subscribers and return the previous value.
///
/// Shorthand for `Observable::set(this, T::default())`.
pub async fn take_async(this: &mut Self) -> T
where
T: Default,
{
Self::set_async(this, T::default()).await
}
/// Update the inner value and notify subscribers.
///
/// Note that even if the inner value is not actually changed by the
/// closure, subscribers will be notified as if it was. Use
/// [`update_if`][Self::update_if] if you want to conditionally mutate the
/// inner value.
pub async fn update_async(this: &mut Self, f: impl FnOnce(&mut T)) {
SharedAsync::lock(&mut this.state).await.update(f);
}
/// Maybe update the inner value and notify subscribers if it changed.
///
/// The closure given to this function must return `true` if subscribers
/// should be notified of a change to the inner value.
pub async fn update_if_async(this: &mut Self, f: impl FnOnce(&mut T) -> bool) {
SharedAsync::lock(&mut this.state).await.update_if(f);
}
}
impl<T, L: Lock> Observable<T, L> {
pub(crate) fn from_inner(state: L::Shared<ObservableState<T>>) -> Self {
Self { state }
}
/// Get the number of subscribers.
///
/// Be careful when using this. The result is only reliable if it is exactly
/// `0`, as otherwise it could be incremented right after your call to this
/// function, before you look at its result or do anything based on that.
#[must_use]
pub fn subscriber_count(this: &Self) -> usize {
L::shared_read_count(&this.state)
}
/// Convert this unique `Observable` into a [`SharedObservable`].
///
/// Any subscribers created for `self` remain valid.
pub fn into_shared(this: Self) -> SharedObservable<T, L> {
// Destructure `this` without running `Drop`.
let state = unsafe { ptr::read(&this.state) };
mem::forget(this);
let rwlock = L::shared_into_inner(state);
SharedObservable::from_inner(rwlock)
}
}
impl<T, L: Lock> fmt::Debug for Observable<T, L>
where
L::Shared<ObservableState<T>>: fmt::Debug,
{
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("SharedObservable").field("state", &self.state).finish()
}
}
impl<T, L> Default for Observable<T, L>
where
T: Default,
L: Lock,
{
fn default() -> Self {
let shared = L::new_shared(ObservableState::new(T::default()));
Self::from_inner(shared)
}
}
// Note: No DerefMut because all mutating must go through inherent methods that
// notify subscribers
impl<T> ops::Deref for Observable<T> {
type Target = T;
fn deref(&self) -> &Self::Target {
self.state.get()
}
}
impl<T, L: Lock> Drop for Observable<T, L> {
fn drop(&mut self) {
self.state.close();
}
}