Struct futures_util::sink::Fanout

source · [−]

pub struct Fanout<Si1, Si2> { /* private fields */ }

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

source

impl<Si1, Si2> Fanout<Si1, Si2>

source

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

Get a shared reference to the inner sinks.

source

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

Get a mutable reference to the inner sinks.

source

pub fn get_pin_mut(self: Pin<&mut Self>) -> (Pin<&mut Si1>, Pin<&mut Si2>)

Get a pinned mutable reference to the inner sinks.

source

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

source

impl<Si1: Debug, Si2: Debug> Debug for Fanout<Si1, Si2>

source

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

Formats the value using the given formatter. Read more

source

impl<Si1, Si2, Item> Sink<Item> for Fanout<Si1, Si2>where
 Si1: Sink<Item>,
 Item: Clone,
 Si2: Sink<Item, Error = Si1::Error>,

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

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

source

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

Attempts to prepare the Sink to receive a value. Read more

source

fn start_send(self: Pin<&mut Self>, item: Item) -> 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(())). Read more

source

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

Flush any remaining output from this sink. Read more

source

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

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

source

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

Auto Trait Implementations

impl<Si1, Si2> RefUnwindSafe for Fanout<Si1, Si2>where
Si1: RefUnwindSafe,
Si2: RefUnwindSafe,

impl<Si1, Si2> Send for Fanout<Si1, Si2>where
Si1: Send,
Si2: Send,

impl<Si1, Si2> Sync for Fanout<Si1, Si2>where
Si1: Sync,
Si2: Sync,

impl<Si1, Si2> UnwindSafe for Fanout<Si1, Si2>where
Si1: UnwindSafe,
Si2: UnwindSafe,

Blanket Implementations

source

impl<T> Any for Twhere
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for Twhere
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T, Item> SinkExt<Item> for Twhere
T: Sink<Item> + ?Sized,

source

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,

Composes a function in front of the sink. Read more

source

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,

Composes a function in front of the sink. Read more

source

fn sink_map_err<E, F>(self, f: F) -> SinkMapErr<Self, F>where
F: FnOnce(Self::Error) -> E,
Self: Sized,

Transforms the error returned by the sink.

source

fn sink_err_into<E>(self) -> SinkErrInto<Self, Item, E>where
Self: Sized,
Self::Error: Into<E>,

Map this sink’s error to a different error type using the Into trait. Read more

source

fn buffer(self, capacity: usize) -> Buffer<Self, Item>where
Self: Sized,

Adds a fixed-size buffer to the current sink. Read more

source

fn close(&mut self) -> Close<'_, Self, Item>ⓘNotable traits for Close<'_, Si, Item>`impl<Si: Sink<Item> + Unpin + ?Sized, Item> Future for Close<'_, Si, Item> type Output = Result<(), Si::Error>;`where
Self: Unpin,

Close the sink.

source

fn fanout<Si>(self, other: Si) -> Fanout<Self, Si>where
 Self: Sized,
 Item: Clone,
 Si: Sink<Item, Error = Self::Error>,

Fanout items to multiple sinks. Read more

source

fn flush(&mut self) -> Flush<'_, Self, Item>ⓘNotable traits for Flush<'_, Si, Item>`impl<Si: Sink<Item> + Unpin + ?Sized, Item> Future for Flush<'_, Si, Item> type Output = Result<(), Si::Error>;`where
Self: Unpin,

Flush the sink, processing all pending items. Read more

source

fn send(&mut self, item: Item) -> Send<'_, Self, Item>ⓘNotable traits for Send<'_, Si, Item>`impl<Si: Sink<Item> + Unpin + ?Sized, Item> Future for Send<'_, Si, Item> type Output = Result<(), Si::Error>;`where
Self: Unpin,

A future that completes after the given item has been fully processed into the sink, including flushing. Read more

source

fn feed(&mut self, item: Item) -> Feed<'_, Self, Item>ⓘNotable traits for Feed<'_, Si, Item>`impl<Si: Sink<Item> + Unpin + ?Sized, Item> Future for Feed<'_, Si, Item> type Output = Result<(), Si::Error>;`where
Self: Unpin,

A future that completes after the given item has been received by the sink. Read more

source

fn send_all<'a, St>(&'a mut self, stream: &'a mut St) -> SendAll<'a, Self, St>ⓘNotable traits for SendAll<'_, Si, St>`impl<Si, St, Ok, Error> Future for SendAll<'_, Si, St>where Si: Sink<Ok, Error = Error> + Unpin + ?Sized, St: Stream<Item = Result<Ok, Error>> + Unpin + ?Sized, type Output = Result<(), Error>;`where
 St: TryStream<Ok = Item, Error = Self::Error> + Stream + Unpin + ?Sized,
 Self: Unpin,

A future that completes after the given stream has been fully processed into the sink, including flushing. Read more

source

fn left_sink<Si2>(self) -> Either<Self, Si2>ⓘNotable traits for Either<A, B>`impl<A, B> Future for Either<A, B>where A: Future, B: Future<Output = A::Output>, type Output = A::Output;`where
 Si2: Sink<Item, Error = Self::Error>,
 Self: Sized,

Wrap this sink in an Either sink, making it the left-hand variant of that Either. Read more

source

fn right_sink<Si1>(self) -> Either<Si1, Self>ⓘNotable traits for Either<A, B>`impl<A, B> Future for Either<A, B>where A: Future, B: Future<Output = A::Output>, type Output = A::Output;`where
 Si1: Sink<Item, Error = Self::Error>,
 Self: Sized,

Wrap this stream in an Either stream, making it the right-hand variant of that Either. Read more

source

fn poll_ready_unpin(
 &mut self,
 cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>where
 Self: Unpin,

A convenience method for calling Sink::poll_ready on Unpin sink types. Read more

source

fn start_send_unpin(&mut self, item: Item) -> Result<(), Self::Error>where
Self: Unpin,

A convenience method for calling Sink::start_send on Unpin sink types. Read more

source

fn poll_flush_unpin(
 &mut self,
 cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>where
 Self: Unpin,

A convenience method for calling Sink::poll_flush on Unpin sink types. Read more

source

fn poll_close_unpin(
 &mut self,
 cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>where
 Self: Unpin,

A convenience method for calling Sink::poll_close on Unpin sink types. Read more

source

impl<T, U> TryFrom for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for Twhere
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct futures_util::sink::Fanout

Implementations

impl<Si1, Si2> Fanout<Si1, Si2>

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

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

pub fn get_pin_mut(self: Pin<&mut Self>) -> (Pin<&mut Si1>, Pin<&mut Si2>)

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

Trait Implementations

impl<Si1: Debug, Si2: Debug> Debug for Fanout<Si1, Si2>

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

impl<Si1, Si2, Item> Sink<Item> for Fanout<Si1, Si2>where Si1: Sink<Item>, Item: Clone, Si2: Sink<Item, Error = Si1::Error>,

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

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

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

fn poll_flush( 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>>

impl<'__pin, Si1, Si2> Unpin for Fanout<Si1, Si2>where __Origin<'__pin, Si1, Si2>: Unpin,

Auto Trait Implementations

impl<Si1, Si2> RefUnwindSafe for Fanout<Si1, Si2>where Si1: RefUnwindSafe, Si2: RefUnwindSafe,

impl<Si1, Si2> Send for Fanout<Si1, Si2>where Si1: Send, Si2: Send,

impl<Si1, Si2> Sync for Fanout<Si1, Si2>where Si1: Sync, Si2: Sync,

impl<Si1, Si2> UnwindSafe for Fanout<Si1, Si2>where Si1: UnwindSafe, Si2: UnwindSafe,

Blanket Implementations

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<T, Item> SinkExt<Item> for Twhere T: Sink<Item> + ?Sized,

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,

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,

fn sink_map_err<E, F>(self, f: F) -> SinkMapErr<Self, F>where F: FnOnce(Self::Error) -> E, Self: Sized,

fn sink_err_into<E>(self) -> SinkErrInto<Self, Item, E>where Self: Sized, Self::Error: Into<E>,

fn buffer(self, capacity: usize) -> Buffer<Self, Item>where Self: Sized,

fn close(&mut self) -> Close<'_, Self, Item>ⓘNotable traits for Close<'_, Si, Item>impl<Si: Sink<Item> + Unpin + ?Sized, Item> Future for Close<'_, Si, Item> type Output = Result<(), Si::Error>;where Self: Unpin,

fn fanout<Si>(self, other: Si) -> Fanout<Self, Si>where Self: Sized, Item: Clone, Si: Sink<Item, Error = Self::Error>,

fn flush(&mut self) -> Flush<'_, Self, Item>ⓘNotable traits for Flush<'_, Si, Item>impl<Si: Sink<Item> + Unpin + ?Sized, Item> Future for Flush<'_, Si, Item> type Output = Result<(), Si::Error>;where Self: Unpin,

fn send(&mut self, item: Item) -> Send<'_, Self, Item>ⓘNotable traits for Send<'_, Si, Item>impl<Si: Sink<Item> + Unpin + ?Sized, Item> Future for Send<'_, Si, Item> type Output = Result<(), Si::Error>;where Self: Unpin,

fn feed(&mut self, item: Item) -> Feed<'_, Self, Item>ⓘNotable traits for Feed<'_, Si, Item>impl<Si: Sink<Item> + Unpin + ?Sized, Item> Future for Feed<'_, Si, Item> type Output = Result<(), Si::Error>;where Self: Unpin,

fn left_sink<Si2>(self) -> Either<Self, Si2>ⓘNotable traits for Either<A, B>impl<A, B> Future for Either<A, B>where A: Future, B: Future<Output = A::Output>, type Output = A::Output;where Si2: Sink<Item, Error = Self::Error>, Self: Sized,

fn right_sink<Si1>(self) -> Either<Si1, Self>ⓘNotable traits for Either<A, B>impl<A, B> Future for Either<A, B>where A: Future, B: Future<Output = A::Output>, type Output = A::Output;where Si1: Sink<Item, Error = Self::Error>, Self: Sized,

fn poll_ready_unpin( &mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>where Self: Unpin,

fn start_send_unpin(&mut self, item: Item) -> Result<(), Self::Error>where Self: Unpin,

fn poll_flush_unpin( &mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>where Self: Unpin,

fn poll_close_unpin( &mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>where Self: Unpin,

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<Si1, Si2, Item> Sink<Item> for Fanout<Si1, Si2>where
Si1: Sink<Item>,
Item: Clone,
Si2: Sink<Item, Error = Si1::Error>,

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

fn poll_flush(
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>>

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

impl<Si1, Si2> RefUnwindSafe for Fanout<Si1, Si2>where
Si1: RefUnwindSafe,
Si2: RefUnwindSafe,

impl<Si1, Si2> Send for Fanout<Si1, Si2>where
Si1: Send,
Si2: Send,

impl<Si1, Si2> Sync for Fanout<Si1, Si2>where
Si1: Sync,
Si2: Sync,

impl<Si1, Si2> UnwindSafe for Fanout<Si1, Si2>where
Si1: UnwindSafe,
Si2: UnwindSafe,

impl<T> Any for Twhere
T: 'static + ?Sized,

impl<T> Borrow<T> for Twhere
T: ?Sized,

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

impl<T, U> Into<U> for Twhere
U: From<T>,

impl<T, Item> SinkExt<Item> for Twhere
T: Sink<Item> + ?Sized,

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,

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,

fn sink_map_err<E, F>(self, f: F) -> SinkMapErr<Self, F>where
F: FnOnce(Self::Error) -> E,
Self: Sized,

fn sink_err_into<E>(self) -> SinkErrInto<Self, Item, E>where
Self: Sized,
Self::Error: Into<E>,

fn buffer(self, capacity: usize) -> Buffer<Self, Item>where
Self: Sized,

fn close(&mut self) -> Close<'_, Self, Item>ⓘNotable traits for Close<'_, Si, Item>`impl<Si: Sink<Item> + Unpin + ?Sized, Item> Future for Close<'_, Si, Item> type Output = Result<(), Si::Error>;`where
Self: Unpin,

fn fanout<Si>(self, other: Si) -> Fanout<Self, Si>where
Self: Sized,
Item: Clone,
Si: Sink<Item, Error = Self::Error>,

fn flush(&mut self) -> Flush<'_, Self, Item>ⓘNotable traits for Flush<'_, Si, Item>`impl<Si: Sink<Item> + Unpin + ?Sized, Item> Future for Flush<'_, Si, Item> type Output = Result<(), Si::Error>;`where
Self: Unpin,

fn send(&mut self, item: Item) -> Send<'_, Self, Item>ⓘNotable traits for Send<'_, Si, Item>`impl<Si: Sink<Item> + Unpin + ?Sized, Item> Future for Send<'_, Si, Item> type Output = Result<(), Si::Error>;`where
Self: Unpin,

fn feed(&mut self, item: Item) -> Feed<'_, Self, Item>ⓘNotable traits for Feed<'_, Si, Item>`impl<Si: Sink<Item> + Unpin + ?Sized, Item> Future for Feed<'_, Si, Item> type Output = Result<(), Si::Error>;`where
Self: Unpin,

fn left_sink<Si2>(self) -> Either<Self, Si2>ⓘNotable traits for Either<A, B>`impl<A, B> Future for Either<A, B>where A: Future, B: Future<Output = A::Output>, type Output = A::Output;`where
Si2: Sink<Item, Error = Self::Error>,
Self: Sized,

fn right_sink<Si1>(self) -> Either<Si1, Self>ⓘNotable traits for Either<A, B>`impl<A, B> Future for Either<A, B>where A: Future, B: Future<Output = A::Output>, type Output = A::Output;`where
Si1: Sink<Item, Error = Self::Error>,
Self: Sized,

fn poll_ready_unpin(
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>where
Self: Unpin,

fn start_send_unpin(&mut self, item: Item) -> Result<(), Self::Error>where
Self: Unpin,

fn poll_flush_unpin(
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>where
Self: Unpin,

fn poll_close_unpin(
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>where
Self: Unpin,

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,