Struct pharos::SharedPharos

pub struct SharedPharos<Event> where
    Event: 'static + Clone + Send,  { /* fields omitted */ }

A handy wrapper that uses a futures aware mutex to allow using Pharos from a shared reference.

Implementations

impl<Event> SharedPharos<Event> where
    Event: 'static + Clone + Send, 

pub fn new(pharos: Pharos<Event>) -> Self

Create a SharedPharos object.

pub async fn notify(&self, evt: Event) -> Result<(), PharErr>

Notify observers.

pub async fn observe_shared(
    &self,
    options: ObserveConfig<Event>
) -> Result<Events<Event>, <Self as Observable<Event>>::Error>

Start Observing this Pharos object.

Trait Implementations

impl<Event: Clone> Clone for SharedPharos<Event> where
    Event: 'static + Clone + Send, 

fn clone(&self) -> SharedPharos<Event>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Event: Debug> Debug for SharedPharos<Event> where
    Event: 'static + Clone + Send, 

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

Formats the value using the given formatter.

impl<Event> Default for SharedPharos<Event> where
    Event: 'static + Clone + Send, 

fn default() -> Self

Returns the “default value” for a type.

impl<Event> Observable<Event> for SharedPharos<Event> where
    Event: 'static + Clone + Send, 

type Error = PharErr

The error type that is returned if observing is not possible.

fn observe(
    &mut self,
    options: ObserveConfig<Event>
) -> Observe<'_, Event, Self::Error>

Add an observer to the observable. Options allow chosing the channel type and to filter events with a predicate.