Struct StateWatcher

pub struct StateWatcher(/* private fields */);

The wrapper around the watch::Receiver<State>. It repeats the Receiver functionality + a new one.

Implementations

impl StateWatcher

pub fn borrow(&self) -> Ref<'_, State>

See watch::Receiver::borrow.

pub fn borrow_and_update(&mut self) -> Ref<'_, State>

See watch::Receiver::borrow_and_update.

pub fn has_changed(&self) -> Result<bool, RecvError>

See watch::Receiver::has_changed.

pub async fn changed(&mut self) -> Result<(), RecvError>

See watch::Receiver::changed.

pub fn same_channel(&self, other: &Self) -> bool

See watch::Receiver::same_channel.

impl StateWatcher

pub async fn while_started(&mut self) -> Result<State>

Infinity loop while the state is State::Started. Returns the next received state.

pub async fn wait_stopping_or_stopped(&mut self) -> Result<()>

Future that resolves once the state is State::Stopped.

Trait Implementations

impl Clone for StateWatcher

fn clone(&self) -> StateWatcher

Returns a copy of the value.

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

Performs copy-assignment from source.

impl From<Receiver<State>> for StateWatcher

fn from(receiver: Receiver<State>) -> Self

Converts to this type from the input type.