futures_util::sink

Struct Fanout

Source
pub struct Fanout<A: Sink, B: Sink> { /* 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<A: Sink, B: Sink> Fanout<A, B>

Source

pub fn into_inner(self) -> (A, B)

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<A: Clone + Sink, B: Clone + Sink> Clone for Fanout<A, B>

Source§

fn clone(&self) -> Fanout<A, B>

Returns a copy of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<A: Sink + Debug, B: Sink + Debug> Debug for Fanout<A, B>
where A::SinkItem: Debug, B::SinkItem: Debug,

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<A, B> Sink for Fanout<A, B>
where A: Sink, A::SinkItem: Clone, B: Sink<SinkItem = A::SinkItem, SinkError = A::SinkError>,

Source§

type SinkItem = <A as Sink>::SinkItem

The type of value that the sink accepts.
Source§

type SinkError = <A as Sink>::SinkError

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

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

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

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

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 Ok(Async::Ready(())). Read more
Source§

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

Flush any remaining output from this sink. Read more
Source§

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

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

Auto Trait Implementations§

§

impl<A, B> Freeze for Fanout<A, B>
where A: Freeze, B: Freeze,

§

impl<A, B> RefUnwindSafe for Fanout<A, B>

§

impl<A, B> Send for Fanout<A, B>
where A: Send, B: Send,

§

impl<A, B> Sync for Fanout<A, B>
where A: Sync, B: Sync,

§

impl<A, B> Unpin for Fanout<A, B>
where A: Unpin, B: Unpin,

§

impl<A, B> UnwindSafe for Fanout<A, B>
where A: UnwindSafe, B: UnwindSafe,

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

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

Source§

fn with<U, Fut, F>(self, f: F) -> With<Self, U, Fut, F>
where F: FnMut(U) -> Fut, Fut: IntoFuture<Item = Self::SinkItem>, Fut::Error: From<Self::SinkError>, 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, U, St, F>
where F: FnMut(U) -> St, St: Stream<Item = Self::SinkItem, Error = Self::SinkError>, 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::SinkError) -> E, Self: Sized,

Transforms the error returned by the sink.
Source§

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

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

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

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

fn close(self) -> Close<Self>
where Self: Sized,

Close the sink. Read more
Source§

fn fanout<S>(self, other: S) -> Fanout<Self, S>
where Self: Sized, Self::SinkItem: Clone, S: Sink<SinkItem = Self::SinkItem, SinkError = Self::SinkError>,

Fanout items to multiple sinks. Read more
Source§

fn flush(self) -> Flush<Self>
where Self: Sized,

Flush the sync, processing all pending items. Read more
Source§

fn send(self, item: Self::SinkItem) -> Send<Self>
where Self: Sized,

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

fn send_all<S>(self, stream: S) -> SendAll<Self, S>
where S: Stream<Item = Self::SinkItem>, Self::SinkError: From<S::Error>, Self: Sized,

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

fn left_sink<B>(self) -> Either<Self, B>
where B: Sink<SinkItem = Self::SinkItem, SinkError = Self::SinkError>, Self: Sized,

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

fn right_sink<B>(self) -> Either<B, Self>
where B: Sink<SinkItem = Self::SinkItem, SinkError = Self::SinkError>, Self: Sized,

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

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.