[−][src]Struct flo_stream::PublisherSink
An implementation of the Sink trait that can be applied to publishers
Methods
impl<Publisher> PublisherSink<Publisher> where
Publisher: MessagePublisher, [src]
Publisher: MessagePublisher,
pub fn as_publisher<'a>(&'a mut self) -> Option<&'a mut Publisher>[src]
Provides access to the underlying MessagePublisher for this sink
pub fn subscribe(&mut self) -> Option<Subscriber<Publisher::Message>>[src]
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>>>[src]
&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, ()>>[src]
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, ()>>[src]
&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, [src]
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>>[src]
self: Pin<&mut Self>,
cx: &mut Context
) -> Poll<Result<(), Self::Error>>
fn start_send(
self: Pin<&mut Self>,
item: Publisher::Message
) -> Result<(), Self::Error>[src]
self: Pin<&mut Self>,
item: Publisher::Message
) -> Result<(), Self::Error>
fn poll_flush(
self: Pin<&mut Self>,
cx: &mut Context
) -> Poll<Result<(), Self::Error>>[src]
self: Pin<&mut Self>,
cx: &mut Context
) -> Poll<Result<(), Self::Error>>
fn poll_close(
self: Pin<&mut Self>,
cx: &mut Context
) -> Poll<Result<(), Self::Error>>[src]
self: Pin<&mut Self>,
cx: &mut Context
) -> Poll<Result<(), Self::Error>>
Auto Trait Implementations
impl<Publisher> !RefUnwindSafe for PublisherSink<Publisher>
impl<Publisher> Send for PublisherSink<Publisher>
impl<Publisher> !Sync for PublisherSink<Publisher>
impl<Publisher> Unpin for PublisherSink<Publisher> where
Publisher: Unpin,
Publisher: Unpin,
impl<Publisher> !UnwindSafe for PublisherSink<Publisher>
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized, [src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized, [src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized, [src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T[src]
impl<T> From<T> for T[src]
impl<T, U> Into<U> for T where
U: From<T>, [src]
U: From<T>,
impl<T, Item> SinkExt<Item> for T where
T: Sink<Item> + ?Sized, [src]
T: Sink<Item> + ?Sized,
fn with<U, Fut, F, E>(self, f: F) -> With<Self, Item, U, Fut, F> where
E: From<Self::Error>,
F: FnMut(U) -> Fut,
Fut: Future<Output = Result<Item, E>>, [src]
E: From<Self::Error>,
F: FnMut(U) -> Fut,
Fut: Future<Output = Result<Item, E>>,
fn with_flat_map<U, St, F>(self, f: F) -> WithFlatMap<Self, Item, U, St, F> where
F: FnMut(U) -> St,
St: Stream<Item = Result<Item, Self::Error>>, [src]
F: FnMut(U) -> St,
St: Stream<Item = Result<Item, Self::Error>>,
fn sink_map_err<E, F>(self, f: F) -> SinkMapErr<Self, F> where
F: FnOnce(Self::Error) -> E, [src]
F: FnOnce(Self::Error) -> E,
fn sink_err_into<E>(self) -> SinkErrInto<Self, Item, E> where
Self::Error: Into<E>, [src]
Self::Error: Into<E>,
fn buffer(self, capacity: usize) -> Buffer<Self, Item>[src]
fn close(&mut self) -> Close<Self, Item> where
Self: Unpin, [src]
Self: Unpin,
fn fanout<Si>(self, other: Si) -> Fanout<Self, Si> where
Item: Clone,
Si: Sink<Item, Error = Self::Error>, [src]
Item: Clone,
Si: Sink<Item, Error = Self::Error>,
fn flush(&mut self) -> Flush<Self, Item> where
Self: Unpin, [src]
Self: Unpin,
fn send(&mut self, item: Item) -> Send<Self, Item> where
Self: Unpin, [src]
Self: Unpin,
fn send_all<St>(&'a mut self, stream: &'a mut St) -> SendAll<'a, Self, St> where
Self: Unpin,
St: TryStream<Ok = Item, Error = Self::Error> + Stream + Unpin + ?Sized, [src]
Self: Unpin,
St: TryStream<Ok = Item, Error = Self::Error> + Stream + Unpin + ?Sized,
fn left_sink<Si2>(self) -> Either<Self, Si2> where
Si2: Sink<Item, Error = Self::Error>, [src]
Si2: Sink<Item, Error = Self::Error>,
fn right_sink<Si1>(self) -> Either<Si1, Self> where
Si1: Sink<Item, Error = Self::Error>, [src]
Si1: Sink<Item, Error = Self::Error>,
impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]
U: TryFrom<T>,