Struct yrs::observer::Observer

pub struct Observer<E> { /* private fields */ }

Data structure used to handle publish/subscribe callbacks of specific type. Observers perform subscriber changes in thread-safe manner, using atomic hardware intrinsics.

Implementations

impl<E> Observer<E>

pub fn new() -> Self

Creates a new Observer with no active callbacks.

pub fn has_subscribers(&self) -> bool

pub fn clean(&self)

Cleanup already released subscriptions. Whenever a Subscription is dropped, the callback is released. However, the weak reference to callback may still be kept around until it becomes touched by operations such as Observer::subscribe or Observer::callbacks.

This method allows to perform stale callback cleanup without waiting for callbacks to be visited.

pub fn subscribe<F>(&self, callback: F) -> Subscription

where F: Fn(&TransactionMut<'_>, &E) + 'static,

Subscribes a callback parameter to a current Observer. Returns a subscription object which - when dropped - will unsubscribe current callback.

pub fn callbacks(&self) -> Option<Callbacks<'_, E>>

Returns a snapshot of callbacks subscribed to this observer at the moment when this method has been called. This snapshot can be iterated over to get access to individual callbacks and trigger them.

Trait Implementations

impl<E: Debug> Debug for Observer<E>

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

Formats the value using the given formatter.

impl<E> Default for Observer<E>

fn default() -> Self

Returns the “default value” for a type.

impl<E: Send> Send for Observer<E>

impl<E: Sync> Sync for Observer<E>