Skip to main content

WatchChannel

Struct WatchChannel 

Source
pub struct WatchChannel { /* private fields */ }
Expand description

Observes changes of the latest state value: holds and updates one value, and all observers (WatchChannel::subscribe) are notified when it changes.

The semantics are “latest value”, not a message queue:

  • observers are only guaranteed to eventually see the latest value, not every intermediate change — values overwritten between two notify calls are never re-sent;
  • unbounded: a new value simply replaces the old one; there is no queue capacity, and no backpressure;
  • observers are independent of each other; how fast one consumes does not affect the others.

Driven by the MessageChannel interface:

Implements Clone — every clone is a sender of the same channel, and any clone’s notify notifies all observers.

§Example

use molo::{MessageChannel, WatchChannel};

let status = WatchChannel::new();
let sub_a = status.subscribe();
let sub_b = status.subscribe();

status.notify("ready").await?;
assert_eq!(sub_a.recv().await?.text(), "ready");
assert_eq!(sub_b.recv().await?.text(), "ready");

§Notes

  • the initial value is an empty string: before the first notify, recv keeps waiting;
  • when there are no observers (never subscribed, or all observers have been dropped), notify returns ChannelError::NoReceiver — unlike BroadcastChannel, which succeeds silently even with nobody listening, so subscribe first, then notify; the channel itself is not closed, and notify works again after re-subscribing.

Implementations§

Source§

impl WatchChannel

Source

pub fn new() -> Self

Creates a watch channel whose initial value is an empty string.

Before the first notify, a subscriber’s recv keeps waiting.

Source

pub fn subscribe(&self) -> WatchReceiver

Subscribes to value changes; each observer gets an independent receive end, unaffected by the others.

Trait Implementations§

Source§

impl Clone for WatchChannel

Source§

fn clone(&self) -> WatchChannel

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for WatchChannel

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for WatchChannel

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl MessageChannel for WatchChannel

Source§

fn ask<'life0, 'life1, 'async_trait>( &'life0 self, _message: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<String, ChannelError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Sends a question and waits for a reply (request-response). Read more
Source§

fn notify<'life0, 'life1, 'async_trait>( &'life0 self, message: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<(), ChannelError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

A one-way notification that does not wait for a reply (broadcast to all receivers).

Auto Trait Implementations§

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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