Struct Mediator 

pub struct Mediator<T, E> { /* private fields */ }

A mediator is a central hub for communication between futures.

Implementations

impl<T, E> Mediator<T, E>

pub fn new(value: T) -> Self

Create new mediator with shared value.

pub async fn with<F, R>(&self, f: F) -> R

where F: FnOnce(&T) -> R,

Acquire the lock and access immutable shared data.

pub async fn with_mut<F, R>(&self, f: F) -> R

where F: FnOnce(&mut T) -> R,

Acquire the lock and access mutable shared data.

pub fn try_lock(&self) -> Option<MutexGuard<'_, Shared<T, E>>>

Attempt to acquire the shared data lock immediately.

If the lock is currently held, this will return None.

pub async fn notify(&self, event: E)

where E: Eq + Hash + Debug,

Emit one event on.

pub async fn notify_all<Events: AsRef<[E]>>(&self, events: Events)

where E: Eq + Hash + Clone + Debug,

Emit all events

pub fn on_fn<F, R>(&self, event: E, f: F) -> OnEvent<T, E, F>

where F: FnMut(&mut Shared<T, E>, &mut Context<'_>) -> Poll<R> + Unpin, T: Unpin + 'static, E: Unpin + Eq + Hash + Debug, R: Unpin,

Create a new event handle future with poll function f and run once immediately

If f returns Pending, the system will move the handle into the event waiting map, and the future returns Pending status.

You can call notify to wake up this poll function and run once again.

Trait Implementations

impl<T, E> Clone for Mediator<T, E>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug, E: Debug> Debug for Mediator<T, E>

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

Formats the value using the given formatter.