Struct futures_util::sink::Fanout [−][src]
#[must_use = "sinks do nothing unless polled"]pub struct Fanout<Si1, Si2> { /* fields omitted */ }
sink
only.Expand description
Sink that clones incoming items and forwards them to two sinks at the same time.
Backpressure from any downstream sink propagates up, which means that this sink can only process items as fast as its slowest downstream sink.
Implementations
impl<Si1, Si2> Fanout<Si1, Si2>
[src]
impl<Si1, Si2> Fanout<Si1, Si2>
[src]pub fn get_pin_mut(self: Pin<&mut Self>) -> (Pin<&mut Si1>, Pin<&mut Si2>)
[src]
pub fn get_pin_mut(self: Pin<&mut Self>) -> (Pin<&mut Si1>, Pin<&mut Si2>)
[src]Get a pinned mutable reference to the inner sinks.
pub fn into_inner(self) -> (Si1, Si2)
[src]
pub fn into_inner(self) -> (Si1, Si2)
[src]Consumes this combinator, returning the underlying sinks.
Note that this may discard intermediate state of this combinator, so care should be taken to avoid losing resources when this is called.
Trait Implementations
impl<Si1, Si2, Item> Sink<Item> for Fanout<Si1, Si2> where
Si1: Sink<Item>,
Item: Clone,
Si2: Sink<Item, Error = Si1::Error>,
[src]
impl<Si1, Si2, Item> Sink<Item> for Fanout<Si1, Si2> where
Si1: Sink<Item>,
Item: Clone,
Si2: Sink<Item, Error = Si1::Error>,
[src]fn poll_ready(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>
[src]
fn poll_ready(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>
[src]Attempts to prepare the Sink
to receive a value. Read more
fn start_send(self: Pin<&mut Self>, item: Item) -> Result<(), Self::Error>
[src]
fn start_send(self: Pin<&mut Self>, item: Item) -> Result<(), Self::Error>
[src]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(()))
. Read more
impl<'__pin, Si1, Si2> Unpin for Fanout<Si1, Si2> where
__Origin<'__pin, Si1, Si2>: Unpin,
[src]
__Origin<'__pin, Si1, Si2>: Unpin,
Auto Trait Implementations
impl<Si1, Si2> RefUnwindSafe for Fanout<Si1, Si2> where
Si1: RefUnwindSafe,
Si2: RefUnwindSafe,
Si1: RefUnwindSafe,
Si2: RefUnwindSafe,
impl<Si1, Si2> Send for Fanout<Si1, Si2> where
Si1: Send,
Si2: Send,
Si1: Send,
Si2: Send,
impl<Si1, Si2> Sync for Fanout<Si1, Si2> where
Si1: Sync,
Si2: Sync,
Si1: Sync,
Si2: Sync,
impl<Si1, Si2> UnwindSafe for Fanout<Si1, Si2> where
Si1: UnwindSafe,
Si2: UnwindSafe,
Si1: UnwindSafe,
Si2: UnwindSafe,
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T, Item> SinkExt<Item> for T where
T: Sink<Item> + ?Sized,
[src]
impl<T, Item> SinkExt<Item> for T where
T: Sink<Item> + ?Sized,
[src]fn with<U, Fut, F, E>(self, f: F) -> With<Self, Item, U, Fut, F> where
F: FnMut(U) -> Fut,
Fut: Future<Output = Result<Item, E>>,
E: From<Self::Error>,
Self: Sized,
[src]
fn with<U, Fut, F, E>(self, f: F) -> With<Self, Item, U, Fut, F> where
F: FnMut(U) -> Fut,
Fut: Future<Output = Result<Item, E>>,
E: From<Self::Error>,
Self: Sized,
[src]sink
only.Composes a function in front of the sink. Read more
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>>,
Self: Sized,
[src]
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>>,
Self: Sized,
[src]sink
only.Composes a function in front of the sink. Read more
fn sink_map_err<E, F>(self, f: F) -> SinkMapErr<Self, F> where
F: FnOnce(Self::Error) -> E,
Self: Sized,
[src]
fn sink_map_err<E, F>(self, f: F) -> SinkMapErr<Self, F> where
F: FnOnce(Self::Error) -> E,
Self: Sized,
[src]sink
only.Transforms the error returned by the sink.
fn sink_err_into<E>(self) -> SinkErrInto<Self, Item, E> where
Self: Sized,
Self::Error: Into<E>,
[src]
fn sink_err_into<E>(self) -> SinkErrInto<Self, Item, E> where
Self: Sized,
Self::Error: Into<E>,
[src]sink
only.Map this sink’s error to a different error type using the Into
trait. Read more
fn buffer(self, capacity: usize) -> Buffer<Self, Item> where
Self: Sized,
[src]
fn buffer(self, capacity: usize) -> Buffer<Self, Item> where
Self: Sized,
[src]sink
only.Adds a fixed-size buffer to the current sink. Read more
fn close(&mut self) -> Close<'_, Self, Item>ⓘ where
Self: Unpin,
[src]
fn close(&mut self) -> Close<'_, Self, Item>ⓘ where
Self: Unpin,
[src]sink
only.Close the sink.
fn fanout<Si>(self, other: Si) -> Fanout<Self, Si> where
Self: Sized,
Item: Clone,
Si: Sink<Item, Error = Self::Error>,
[src]
fn fanout<Si>(self, other: Si) -> Fanout<Self, Si> where
Self: Sized,
Item: Clone,
Si: Sink<Item, Error = Self::Error>,
[src]sink
only.Fanout items to multiple sinks. Read more
fn flush(&mut self) -> Flush<'_, Self, Item>ⓘ where
Self: Unpin,
[src]
fn flush(&mut self) -> Flush<'_, Self, Item>ⓘ where
Self: Unpin,
[src]sink
only.Flush the sink, processing all pending items. Read more
fn send(&mut self, item: Item) -> Send<'_, Self, Item>ⓘ where
Self: Unpin,
[src]
fn send(&mut self, item: Item) -> Send<'_, Self, Item>ⓘ where
Self: Unpin,
[src]sink
only.A future that completes after the given item has been fully processed into the sink, including flushing. Read more
fn feed(&mut self, item: Item) -> Feed<'_, Self, Item>ⓘ where
Self: Unpin,
[src]
fn feed(&mut self, item: Item) -> Feed<'_, Self, Item>ⓘ where
Self: Unpin,
[src]sink
only.A future that completes after the given item has been received by the sink. Read more
fn send_all<'a, St: ?Sized>(
&'a mut self,
stream: &'a mut St
) -> SendAll<'a, Self, St>ⓘ where
St: TryStream<Ok = Item, Error = Self::Error> + Stream + Unpin,
Self: Unpin,
[src]
fn send_all<'a, St: ?Sized>(
&'a mut self,
stream: &'a mut St
) -> SendAll<'a, Self, St>ⓘ where
St: TryStream<Ok = Item, Error = Self::Error> + Stream + Unpin,
Self: Unpin,
[src]sink
only.A future that completes after the given stream has been fully processed into the sink, including flushing. Read more
fn left_sink<Si2>(self) -> Either<Self, Si2>ⓘ where
Si2: Sink<Item, Error = Self::Error>,
Self: Sized,
[src]
fn left_sink<Si2>(self) -> Either<Self, Si2>ⓘ where
Si2: Sink<Item, Error = Self::Error>,
Self: Sized,
[src]sink
only.Wrap this sink in an Either
sink, making it the left-hand variant
of that Either
. Read more
fn right_sink<Si1>(self) -> Either<Si1, Self>ⓘ where
Si1: Sink<Item, Error = Self::Error>,
Self: Sized,
[src]
fn right_sink<Si1>(self) -> Either<Si1, Self>ⓘ where
Si1: Sink<Item, Error = Self::Error>,
Self: Sized,
[src]sink
only.Wrap this stream in an Either
stream, making it the right-hand variant
of that Either
. Read more
fn compat(self) -> CompatSink<Self, Item> where
Self: Sized + Unpin,
[src]
fn compat(self) -> CompatSink<Self, Item> where
Self: Sized + Unpin,
[src]sink
and compat
only.fn poll_ready_unpin(
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>> where
Self: Unpin,
[src]
fn poll_ready_unpin(
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>> where
Self: Unpin,
[src]sink
only.A convenience method for calling Sink::poll_ready
on Unpin
sink types. Read more
fn start_send_unpin(&mut self, item: Item) -> Result<(), Self::Error> where
Self: Unpin,
[src]
fn start_send_unpin(&mut self, item: Item) -> Result<(), Self::Error> where
Self: Unpin,
[src]sink
only.A convenience method for calling Sink::start_send
on Unpin
sink types. Read more