Skip to main content

Observable

Struct Observable 

Source
pub struct Observable<T> { /* private fields */ }
Expand description

A shared, version-tracked value with change notification.

Cloning an Observable creates a new handle to the same inner state — both handles see the same value and share subscribers.

§Invariants

  1. version increments by exactly 1 on each value-changing mutation.
  2. set(v) where v == current is a no-op.
  3. Subscribers are notified in registration order.
  4. Dead subscribers (dropped Subscription guards) are pruned lazily.

Implementations§

Source§

impl<T: Clone + PartialEq + 'static> Observable<T>

Source

pub fn new(value: T) -> Self

Create a new observable with the given initial value.

The initial version is 0 and no subscribers are registered.

Source

pub fn get(&self) -> T

Get a clone of the current value.

Source

pub fn with<R>(&self, f: impl FnOnce(&T) -> R) -> R

Access the current value by reference without cloning.

The closure f receives an immutable reference to the value.

Source

pub fn set(&self, value: T)

Set a new value. If the new value differs from the current value (by PartialEq), the version is incremented and all live subscribers are notified.

This method is safe to call re-entrantly from within subscriber callbacks.

Source

pub fn update(&self, f: impl FnOnce(&mut T))

Modify the value in place via a closure. If the value changes (compared by PartialEq against a snapshot), the version is incremented and subscribers are notified.

This method is safe to call re-entrantly from within subscriber callbacks.

Source

pub fn subscribe(&self, callback: impl Fn(&T) + 'static) -> Subscription

Subscribe to value changes. The callback is invoked with a reference to the new value each time it changes.

Returns a Subscription guard. Dropping the guard unsubscribes the callback (it will not be called after drop, though it may still be in the subscriber list until the next notify() prunes it).

Source

pub fn version(&self) -> u64

Current version number. Increments by 1 on each value-changing mutation. Useful for dirty-checking in render loops.

Source

pub fn subscriber_count(&self) -> usize

Number of currently registered subscribers (including dead ones not yet pruned).

Trait Implementations§

Source§

impl<T> Clone for Observable<T>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<T: Debug> Debug for Observable<T>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T> Freeze for Observable<T>

§

impl<T> !RefUnwindSafe for Observable<T>

§

impl<T> !Send for Observable<T>

§

impl<T> !Sync for Observable<T>

§

impl<T> Unpin for Observable<T>

§

impl<T> UnsafeUnpin for Observable<T>

§

impl<T> !UnwindSafe for Observable<T>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more