Struct futures::sink::Fanout

[+] Show declaration

[+] Expand attributes
#[must_use = "sinks do nothing unless polled"]pub struct Fanout<Si1, Si2> { /* 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.

Implementations

impl<Si1, Si2> Fanout<Si1, Si2>[−]

pub fn get_ref(&self) -> (&Si1, &Si2)[−]

Get a shared reference to the inner sinks.

pub fn get_mut(&mut self) -> (&mut Si1, &mut Si2)[−]

Get a mutable reference to the inner sinks.

pub fn get_pin_mut(
    self: Pin<&mut Fanout<Si1, Si2>>
) -> (Pin<&mut Si1>, Pin<&mut Si2>)[−]

Get a pinned mutable reference to the inner sinks.

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

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>[−]

Formats the value using the given formatter.

impl<Si1, Si2, Item> Sink<Item> for Fanout<Si1, Si2> where
    Item: Clone,
    Si1: Sink<Item>,
    Si2: Sink<Item, Error = <Si1 as Sink<Item>>::Error>, [+]

[+] Show hidden undocumented items

type Error = <Si1 as Sink<Item>>::Error

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

fn poll_ready(
    self: Pin<&mut Fanout<Si1, Si2>>,
    cx: &mut Context<'_>
) -> Poll<Result<(), <Fanout<Si1, Si2> as Sink<Item>>::Error>>[−]

Attempts to prepare the Sink to receive a value.

fn start_send(
    self: Pin<&mut Fanout<Si1, Si2>>,
    item: Item
) -> Result<(), <Fanout<Si1, Si2> as Sink<Item>>::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 Fanout<Si1, Si2>>,
    cx: &mut Context<'_>
) -> Poll<Result<(), <Fanout<Si1, Si2> as Sink<Item>>::Error>>[−]

Flush any remaining output from this sink.

fn poll_close(
    self: Pin<&mut Fanout<Si1, Si2>>,
    cx: &mut Context<'_>
) -> Poll<Result<(), <Fanout<Si1, Si2> as Sink<Item>>::Error>>[−]

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

impl<'pin, Si1, Si2> Unpin for Fanout<Si1, Si2> where
    __Fanout<'pin, Si1, Si2>: Unpin, 

impl<Si1, Si2> UnsafeUnpin for Fanout<Si1, Si2>