Struct flo_stream::Publisher

pub struct Publisher<Message> { /* fields omitted */ }

A publisher represents a sink that sends messages to zero or more subscribers

Call subscribe() to create subscribers. Any messages sent to this sink will be relayed to all connected subscribers. If the publisher is dropped, any connected subscribers will relay all sent messages and then indicate that they have finished.

Implementations

impl<Message: Clone> Publisher<Message>

pub fn new(buffer_size: usize) -> Publisher<Message>

Creates a new publisher with a particular buffer size

pub fn count_subscribers(&self) -> usize

Counts the number of subscribers in this publisher

pub fn republish(&self) -> Self

Creates a duplicate publisher that can be used to publish to the same streams as this object

pub fn republish_weak(&self) -> WeakPublisher<Message>

Creates a duplicate publisher that can be used to publish to the same streams as this object

This creates a 'weak' publisher, which will stop republishing once all of the 'strong' publishers have been dropped.

Trait Implementations

impl<Message> Drop for Publisher<Message>

fn drop(&mut self)

Executes the destructor for this type.

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

type Message = Message

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

Subscribes to this publisher

Subscribers only receive messages sent to the publisher after they are created.

fn when_ready(&mut self) -> BoxFuture<'static, MessageSender<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

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

Publishes a message to the subscribers of this object