Struct futures_util::sink::Fanout

[+] Show declaration

pub struct Fanout<Si1: Sink, Si2: Sink> { /* fields omitted */ }

[−] 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.

Methods

impl<Si1: Sink, Si2: Sink> Fanout<Si1, Si2>

[−]

pub fn into_inner(self) -> (Si1, Si2)

[−]

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: Sink + Debug, Si2: Sink + Debug> Debug for Fanout<Si1, Si2> where     Si1::SinkItem: Debug,     Si2::SinkItem: Debug,

[+]

fn fmt(&self, f: &mut Formatter) -> FmtResult

[−]

Formats the value using the given formatter.

impl<Si1, Si2> Sink for Fanout<Si1, Si2> where     Si1: Sink,     Si1::SinkItem: Clone,     Si2: Sink<SinkItem = Si1::SinkItem, SinkError = Si1::SinkError>,

[+]

type SinkItem = Si1::SinkItem

The type of value that the sink accepts.

type SinkError = Si1::SinkError

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

fn poll_ready(     self: PinMut<Self>,     cx: &mut Context ) -> Poll<Result<(), Self::SinkError>>

[−]

Attempts to prepare the Sink to receive a value.

fn start_send(     self: PinMut<Self>,     item: Self::SinkItem ) -> Result<(), Self::SinkError>

[−]

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

fn poll_flush(     self: PinMut<Self>,     cx: &mut Context ) -> Poll<Result<(), Self::SinkError>>

[−]

Flush any remaining output from this sink.

fn poll_close(     self: PinMut<Self>,     cx: &mut Context ) -> Poll<Result<(), Self::SinkError>>

[−]

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