Struct PublisherSink 

pub struct PublisherSink<Publisher>
where
    Publisher: MessagePublisher,
{ /* private fields */ }

An implementation of the Sink trait that can be applied to publishers

Implementations

impl<Publisher> PublisherSink<Publisher>

where Publisher: MessagePublisher,

pub fn as_publisher<'a>(&'a mut self) -> Option<&'a mut Publisher>

Provides access to the underlying MessagePublisher for this sink

pub fn subscribe(&mut self) -> Option<Subscriber<Publisher::Message>>

Creates a subscription to this publisher

Any future messages sent here will also be sent to this subscriber. Returns None if the sink has been closed

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

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

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

Waits until all subscribers have consumed all pending messages

Returns None if the sink has been closed.

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

Publishes a message to the subscribers of this object

Returns None if the sink has been closed

Trait Implementations

impl<Publisher> Sink<<Publisher as MessagePublisher>::Message> for PublisherSink<Publisher>

where Publisher: MessagePublisher, Self: Unpin,

type Error = ()

The type of value produced by the sink when an error occurs.

fn poll_ready( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Attempts to prepare the Sink to receive a value.

fn start_send( self: Pin<&mut Self>, item: Publisher::Message, ) -> Result<(), Self::Error>

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())).

fn poll_flush( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Flush any remaining output from this sink.

fn poll_close( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Flush any remaining output and close this sink, if necessary.