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 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561
//! This module defines a [`SharedObservable`] type that is clonable, requires
//! only `&` access to update its inner value but doesn't dereference to the
//! inner value.
//!
//! Use this in situations where multiple locations in the code should be able
//! to update the inner value.
use std::{
fmt,
hash::Hash,
ops,
sync::{Arc, PoisonError, TryLockError, TryLockResult, Weak},
};
use readlock::{SharedReadGuard, SharedReadLock};
#[cfg(feature = "async-lock")]
use readlock_tokio::{
SharedReadGuard as SharedAsyncReadGuard, SharedReadLock as SharedAsyncReadLock,
};
#[cfg(feature = "async-lock")]
use crate::AsyncLock;
use crate::{lock::Lock, state::ObservableState, ObservableReadGuard, Subscriber, SyncLock};
/// A value whose changes will be broadcast to subscribers.
///
/// Unlike [`Observable`](crate::Observable), `SharedObservable` can be
/// `Clone`d but does't dereference to `T`. Because of the latter, it has
/// regular methods to access or modify the inner value.
///
/// # Async-aware locking
///
/// If you want to write-lock the inner value over a `.await` point, that
/// requires an async-aware lock. You can use [`new_async`][Self::new_async] to
/// create a `SharedObservable<T, AsyncLock>`, where most methods are `async`
/// but in return locking the inner value over `.await` points becomes
/// unproblematic.
pub struct SharedObservable<T, L: Lock = SyncLock> {
state: Arc<L::RwLock<ObservableState<T>>>,
/// Ugly hack to track the amount of clones of this observable,
/// *excluding subscribers*.
_num_clones: Arc<()>,
}
impl<T> SharedObservable<T> {
/// Create a new `SharedObservable` with the given initial value.
#[must_use]
pub fn new(value: T) -> Self {
Self::from_inner(Arc::new(std::sync::RwLock::new(ObservableState::new(value))))
}
/// 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(&self) -> Subscriber<T> {
let version = self.state.read().unwrap().version();
Subscriber::new(SharedReadLock::from_inner(Arc::clone(&self.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(&self) -> Subscriber<T> {
Subscriber::new(SharedReadLock::from_inner(Arc::clone(&self.state)), 0)
}
/// Get a clone of the inner value.
pub fn get(&self) -> T
where
T: Clone,
{
self.state.read().unwrap().get().clone()
}
/// Lock the inner with shared read access, blocking the current thread
/// until the lock can be acquired.
///
/// While the returned read guard is alive, nobody can update the inner
/// value. If you want to update the value based on the previous value, do
/// **not** use this method because it can cause races with other clones of
/// the same `SharedObservable`. Instead, call of of the `update_` methods,
/// or if that doesn't fit your use case, call [`write`][Self::write]
/// and update the value through the write guard it returns.
pub fn read(&self) -> ObservableReadGuard<'_, T> {
ObservableReadGuard::new(SharedReadGuard::from_inner(self.state.read().unwrap()))
}
/// Attempts to acquire shared read access to the inner value.
///
/// See [`RwLock`s documentation](https://doc.rust-lang.org/std/sync/struct.RwLock.html#method.try_read)
/// for details.
pub fn try_read(&self) -> TryLockResult<ObservableReadGuard<'_, T>> {
match self.state.try_read() {
Ok(guard) => Ok(ObservableReadGuard::new(SharedReadGuard::from_inner(guard))),
Err(TryLockError::Poisoned(e)) => Err(TryLockError::Poisoned(PoisonError::new(
ObservableReadGuard::new(SharedReadGuard::from_inner(e.into_inner())),
))),
Err(TryLockError::WouldBlock) => Err(TryLockError::WouldBlock),
}
}
/// Lock the inner with exclusive write access, blocking the current thread
/// until the lock can be acquired.
///
/// This can be used to set a new value based on the existing value. The
/// returned write guard dereferences (immutably) to the inner type, and has
/// associated functions to update it.
pub fn write(&self) -> ObservableWriteGuard<'_, T> {
ObservableWriteGuard::new(self.state.write().unwrap())
}
/// Attempts to acquire exclusive write access to the inner value.
///
/// See [`RwLock`s documentation](https://doc.rust-lang.org/std/sync/struct.RwLock.html#method.try_write)
/// for details.
pub fn try_write(&self) -> TryLockResult<ObservableWriteGuard<'_, T>> {
match self.state.try_write() {
Ok(guard) => Ok(ObservableWriteGuard::new(guard)),
Err(TryLockError::Poisoned(e)) => Err(TryLockError::Poisoned(PoisonError::new(
ObservableWriteGuard::new(e.into_inner()),
))),
Err(TryLockError::WouldBlock) => Err(TryLockError::WouldBlock),
}
}
/// Set the inner value to the given `value`, notify subscribers and return
/// the previous value.
pub fn set(&self, value: T) -> T {
self.state.write().unwrap().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(&self, value: T) -> Option<T>
where
T: PartialEq,
{
self.state.write().unwrap().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(&self, value: T) -> Option<T>
where
T: Hash,
{
self.state.write().unwrap().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(T::default())`.
pub fn take(&self) -> T
where
T: Default,
{
self.set(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(&self, f: impl FnOnce(&mut T)) {
self.state.write().unwrap().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(&self, f: impl FnOnce(&mut T) -> bool) {
self.state.write().unwrap().update_if(f);
}
}
#[cfg(feature = "async-lock")]
impl<T: Send + Sync + 'static> SharedObservable<T, AsyncLock> {
/// Create a new async `SharedObservable` with the given initial value.
#[must_use]
pub fn new_async(value: T) -> Self {
Self::from_inner(Arc::new(tokio::sync::RwLock::new(ObservableState::new(value))))
}
/// 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 async fn subscribe(&self) -> Subscriber<T, AsyncLock> {
let version = self.state.read().await.version();
Subscriber::new_async(SharedAsyncReadLock::from_inner(Arc::clone(&self.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(&self) -> Subscriber<T, AsyncLock> {
Subscriber::new_async(SharedAsyncReadLock::from_inner(Arc::clone(&self.state)), 0)
}
/// Get a clone of the inner value.
pub async fn get(&self) -> T
where
T: Clone,
{
self.state.read().await.get().clone()
}
/// Read the inner value.
///
/// While the returned read guard is alive, nobody can update the inner
/// value. If you want to update the value based on the previous value, do
/// **not** use this method because it can cause races with other clones of
/// the same `SharedObservable`. Instead, call of of the `update_` methods,
/// or if that doesn't fit your use case, call [`write`][Self::write]
/// and update the value through the write guard it returns.
pub async fn read(&self) -> ObservableReadGuard<'_, T, AsyncLock> {
ObservableReadGuard::new(SharedAsyncReadGuard::from_inner(self.state.read().await))
}
/// Attempts to acquire shared read access to the inner value.
///
/// If it is already locked for writing, returns `None`.
pub fn try_read(&self) -> Option<ObservableReadGuard<'_, T, AsyncLock>> {
self.state
.try_read()
.ok()
.map(|guard| ObservableReadGuard::new(SharedAsyncReadGuard::from_inner(guard)))
}
/// Get a write guard to the inner value.
///
/// This can be used to set a new value based on the existing value. The
/// returned write guard dereferences (immutably) to the inner type, and has
/// associated functions to update it.
pub async fn write(&self) -> ObservableWriteGuard<'_, T, AsyncLock> {
ObservableWriteGuard::new(self.state.write().await)
}
/// Attempts to acquire exclusive write access to the inner value.
///
/// If it is already locked, returns `None`.
pub fn try_write(&self) -> Option<ObservableWriteGuard<'_, T, AsyncLock>> {
self.state.try_write().ok().map(|guard| ObservableWriteGuard::new(guard))
}
/// Set the inner value to the given `value`, notify subscribers and return
/// the previous value.
pub async fn set(&self, value: T) -> T {
self.state.write().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(&self, value: T) -> Option<T>
where
T: PartialEq,
{
self.state.write().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(&self, value: T) -> Option<T>
where
T: Hash,
{
self.state.write().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(T::default())`.
pub async fn take(&self) -> T
where
T: Default,
{
self.set(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(&self, f: impl FnOnce(&mut T)) {
self.state.write().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(&self, f: impl FnOnce(&mut T) -> bool) {
self.state.write().await.update_if(f);
}
}
impl<T, L: Lock> SharedObservable<T, L> {
pub(crate) fn from_inner(state: Arc<L::RwLock<ObservableState<T>>>) -> Self {
Self { state, _num_clones: Arc::new(()) }
}
/// Get the number of `SharedObservable` clones.
///
/// This always returns at least `1` since `self` is included in the count.
///
/// Be careful when using this. The result is only reliable if it is exactly
/// `1`, 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 observable_count(&self) -> usize {
Arc::strong_count(&self._num_clones)
}
/// Get the number of subscribers.
///
/// Be careful when using this. The result can change 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(&self) -> usize {
self.strong_count() - self.observable_count()
}
/// Get the number of strong references to the inner value.
///
/// Every clone of the `SharedObservable` and every associated `Subscriber`
/// holds a reference, so this is the sum of all clones and subscribers.
/// This always returns at least `1` since `self` is included in the count.
///
/// Equivalent to `ob.observable_count() + ob.subscriber_count()`.
///
/// Be careful when using this. The result is only reliable if it is exactly
/// `1`, 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 strong_count(&self) -> usize {
Arc::strong_count(&self.state)
}
/// Get the number of weak references to the inner value.
///
/// Weak references are created using [`downgrade`][Self::downgrade] or by
/// cloning an existing weak reference.
#[must_use]
pub fn weak_count(&self) -> usize {
Arc::weak_count(&self.state)
}
/// Create a new [`WeakObservable`] reference to the same inner value.
pub fn downgrade(&self) -> WeakObservable<T, L> {
WeakObservable {
state: Arc::downgrade(&self.state),
_num_clones: Arc::downgrade(&self._num_clones),
}
}
}
impl<T, L: Lock> Clone for SharedObservable<T, L> {
fn clone(&self) -> Self {
Self { state: self.state.clone(), _num_clones: self._num_clones.clone() }
}
}
impl<T, L: Lock> fmt::Debug for SharedObservable<T, L>
where
L::RwLock<ObservableState<T>>: fmt::Debug,
{
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("SharedObservable")
.field("state", &self.state)
.field("_num_clones", &self._num_clones)
.finish()
}
}
impl<T, L> Default for SharedObservable<T, L>
where
T: Default,
L: Lock,
{
fn default() -> Self {
let rwlock = L::new_rwlock(ObservableState::new(T::default()));
Self::from_inner(Arc::new(rwlock))
}
}
impl<T, L: Lock> Drop for SharedObservable<T, L> {
fn drop(&mut self) {
// Only close the state if there are no other clones of this
// `SharedObservable`.
if Arc::strong_count(&self._num_clones) == 1 {
// If there are no other clones, obtaining a read lock can't fail.
L::read_noblock(&self.state).close();
}
}
}
/// A weak reference to a [`SharedObservable`].
///
/// This type is only useful in niche cases, since one generally shouldn't nest
/// interior-mutable types in observables, which includes observables
/// themselves.
///
/// See [`std::sync::Weak`] for a general explanation of weak references.
pub struct WeakObservable<T, L: Lock = SyncLock> {
state: Weak<L::RwLock<ObservableState<T>>>,
_num_clones: Weak<()>,
}
impl<T, L: Lock> WeakObservable<T, L> {
/// Attempt to upgrade the `WeakObservable` into a `SharedObservable`.
///
/// Returns `None` if the inner value has already been dropped.
pub fn upgrade(&self) -> Option<SharedObservable<T, L>> {
let state = Weak::upgrade(&self.state)?;
let _num_clones = Weak::upgrade(&self._num_clones)?;
Some(SharedObservable { state, _num_clones })
}
}
impl<T, L: Lock> Clone for WeakObservable<T, L> {
fn clone(&self) -> Self {
Self { state: self.state.clone(), _num_clones: self._num_clones.clone() }
}
}
impl<T, L: Lock> fmt::Debug for WeakObservable<T, L> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("WeakObservable").finish_non_exhaustive()
}
}
/// A write guard for the inner value of an observable.
///
/// Note that as long as an `ObservableWriteGuard` is kept alive, the associated
/// [`SharedObservable`] is locked and can not be updated except through that
/// guard.
#[must_use]
#[clippy::has_significant_drop]
pub struct ObservableWriteGuard<'a, T: 'a, L: Lock = SyncLock> {
inner: L::RwLockWriteGuard<'a, ObservableState<T>>,
}
impl<'a, T: 'a, L: Lock> ObservableWriteGuard<'a, T, L> {
fn new(inner: L::RwLockWriteGuard<'a, ObservableState<T>>) -> Self {
Self { inner }
}
/// Set the inner value to the given `value`, notify subscribers and return
/// the previous value.
pub fn set(this: &mut Self, value: T) -> T {
this.inner.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,
{
this.inner.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,
{
this.inner.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 `ObservableWriteGuard::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)) {
this.inner.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) {
this.inner.update_if(f);
}
}
impl<T: fmt::Debug> fmt::Debug for ObservableWriteGuard<'_, T> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
self.inner.fmt(f)
}
}
impl<T, L: Lock> ops::Deref for ObservableWriteGuard<'_, T, L> {
type Target = T;
fn deref(&self) -> &Self::Target {
self.inner.get()
}
}