Trait MessagePublisher 

pub trait MessagePublisher
where
    Self: Send,
{
    type Message: 'static + Send;

    // Required methods
    fn subscribe(&mut self) -> Subscriber<Self::Message>;
    fn when_ready(&mut self) -> BoxFuture<'static, MessageSender<Self::Message>>;
    fn when_empty(&mut self) -> BoxFuture<'static, ()>;
    fn is_closed(&self) -> bool;
    fn when_closed(&self) -> BoxFuture<'static, ()>;

    // Provided method
    fn publish(&mut self, message: Self::Message) -> BoxFuture<'static, ()> { ... }
}

Trait that provides functions for publishing messages to subscribers

Required Associated Types

type Message: 'static + Send

Required Methods

fn subscribe(&mut self) -> Subscriber<Self::Message>

Creates a subscription to this publisher

Any future messages sent here will also be sent to this subscriber.

fn when_ready(&mut self) -> BoxFuture<'static, MessageSender<Self::Message>>

Reserves a space for a message with the subscribers, returning when it’s ready

fn when_empty(&mut self) -> BoxFuture<'static, ()>

Waits until all subscribers have consumed all pending messages

fn is_closed(&self) -> bool

Returns true if this publisher is closed (will not publish any further messages to its subscribers)

fn when_closed(&self) -> BoxFuture<'static, ()>

Future that returns when this publisher is closed

Provided Methods

fn publish(&mut self, message: Self::Message) -> BoxFuture<'static, ()>

Publishes a message to the subscribers of this object

Implementors

impl<Message: 'static + Send + Clone> MessagePublisher for BlockingPublisher<Message>

type Message = Message

impl<Message: 'static + Send + Clone> MessagePublisher for ExpiringPublisher<Message>

type Message = Message

impl<Message: 'static + Send + Clone> MessagePublisher for Publisher<Message>

type Message = Message

impl<Message: 'static + Send + Clone> MessagePublisher for WeakPublisher<Message>

type Message = Message

impl<Message: 'static + Send> MessagePublisher for SinglePublisher<Message>

type Message = Message