[−][src]Struct futures_util::sink::Fanout

[+] Show declaration

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

[−]

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, Si2> Fanout<Si1, Si2>`[src][−]

`pub fn get_ref(&self) -> (&Si1, &Si2)`[src][+]

Get a shared reference to the inner sinks.

`pub fn get_mut(&mut self) -> (&mut Si1, &mut Si2)`[src][+]

Get a mutable reference to the inner sinks.

`pub fn get_pin_mut<'a>( self: Pin<&'a mut Self> ) -> (Pin<&'a mut Si1>, Pin<&'a mut Si2>) where Si1: Unpin, Si2: Unpin,` [src][+]

Get a pinned mutable reference to the inner sinks.

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

[+] Show hidden undocumented items

`fn fmt(&self, f: &mut Formatter) -> FmtResult`[src][+]

`impl<Si1, Si2, Item> Sink<Item> for Fanout<Si1, Si2> where Si1: Sink<Item>, Item: Clone, Si2: Sink<Item, SinkError = Si1::SinkError>,` [src][+]

[+] Show hidden undocumented items

`type SinkError = Si1::SinkError`

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

`fn poll_ready( self: Pin<&mut Self>, cx: &mut Context ) -> Poll<Result<(), Self::SinkError>>`[src][+]

`fn start_send(self: Pin<&mut Self>, item: Item) -> Result<(), Self::SinkError>`[src][+]

`fn poll_flush( self: Pin<&mut Self>, cx: &mut Context ) -> Poll<Result<(), Self::SinkError>>`[src][+]

`fn poll_close( self: Pin<&mut Self>, cx: &mut Context ) -> Poll<Result<(), Self::SinkError>>`[src][+]

Auto Trait Implementations

`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,`

Blanket Implementations

`impl<T, Item> SinkExt 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::SinkError>, Self: Sized,` [src][+]

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::SinkError>>, Self: Sized,` [src][+]

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::SinkError) -> E, Self: Sized,` [src][+]

Transforms the error returned by the sink.

`fn sink_err_into<E>(self) -> SinkErrInto<Self, Item, E> where Self: Sized, Self::SinkError: Into<E>,` [src][+]

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][+]

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

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

Close the sink.

`fn fanout<Si>(self, other: Si) -> Fanout<Self, Si> where Self: Sized, Item: Clone, Si: Sink<Item, SinkError = Self::SinkError>,` [src][+]

Fanout items to multiple sinks. Read more

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

Flush the sync, processing all pending items. Read more

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

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

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

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

ⓘImportant traits for Either<A, B>
Important 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;`
`fn left_sink<Si2>(self) -> Either<Self, Si2> where Si2: Sink<Item, SinkError = Self::SinkError>, Self: Sized,` [src][+]

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

ⓘImportant traits for Either<A, B>
Important 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;`
`fn right_sink<Si1>(self) -> Either<Si1, Self> where Si1: Sink<Item, SinkError = Self::SinkError>, Self: Sized,` [src][+]

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][+]

Wraps a Sink into a sink compatible with libraries using futures 0.1 Sink. Requires the compat feature to be enabled. Read more

`impl<T> From for T`[src][+]

[+] Show hidden undocumented items

`fn from(t: T) -> T`[src][+]

`impl<T, U> Into for T where U: From<T>,` [src][+]

[+] Show hidden undocumented items

`fn into(self) -> U`[src][+]

`impl<T, U> TryFrom for T where U: Into<T>,` [src][+]

[+] Show hidden undocumented items

`type Error = Infallible`

The type returned in the event of a conversion error.

`fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`[src][+]

`impl<T> Borrow for T where T: ?Sized,` [src][+]

[+] Show hidden undocumented items

ⓘImportant traits for &'_ mut I
Important traits for &'_ mut I
`impl<'_, I> Iterator for &'_ mut I where I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;`
`fn borrow(&self) -> &T`[src][+]

`impl<T> Any for T where T: 'static + ?Sized,` [src][+]

[+] Show hidden undocumented items

`fn type_id(&self) -> TypeId`[src][+]

`impl<T> BorrowMut for T where T: ?Sized,` [src][+]

[+] Show hidden undocumented items

ⓘImportant traits for &'_ mut I
Important traits for &'_ mut I
`impl<'_, I> Iterator for &'_ mut I where I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;`
`fn borrow_mut(&mut self) -> &mut T`[src][+]

`impl<T, U> TryInto for T where U: TryFrom<T>,` [src][+]

[+] Show hidden undocumented items

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

The type returned in the event of a conversion error.

[−][src]Struct futures_util::sink::Fanout

Methods

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

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

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

pub fn get_pin_mut<'a>( self: Pin<&'a mut Self>) -> (Pin<&'a mut Si1>, Pin<&'a mut Si2>) where Si1: Unpin, Si2: Unpin, [src][+]

pub fn into_inner(self) -> (Si1, Si2)[src][+]

Trait Implementations

impl<Si1: Debug, Si2: Debug> Debug for Fanout<Si1, Si2>[src][+]

fn fmt(&self, f: &mut Formatter) -> FmtResult[src][+]

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

type SinkError = Si1::SinkError

fn poll_ready( self: Pin<&mut Self>, cx: &mut Context) -> Poll<Result<(), Self::SinkError>>[src][+]

fn start_send(self: Pin<&mut Self>, item: Item) -> Result<(), Self::SinkError>[src][+]

fn poll_flush( self: Pin<&mut Self>, cx: &mut Context) -> Poll<Result<(), Self::SinkError>>[src][+]

fn poll_close( self: Pin<&mut Self>, cx: &mut Context) -> Poll<Result<(), Self::SinkError>>[src][+]

Auto Trait Implementations

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,

Blanket Implementations

impl<T, Item> SinkExt 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::SinkError>, 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::SinkError>>, Self: Sized, [src][+]

fn sink_map_err<E, F>(self, f: F) -> SinkMapErr<Self, F> where F: FnOnce(Self::SinkError) -> E, Self: Sized, [src][+]

fn sink_err_into<E>(self) -> SinkErrInto<Self, Item, E> where Self: Sized, Self::SinkError: Into<E>, [src][+]

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

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

Important traits for Close<'_, Si, Item>

fn fanout<Si>(self, other: Si) -> Fanout<Self, Si> where Self: Sized, Item: Clone, Si: Sink<Item, SinkError = Self::SinkError>, [src][+]

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

Important traits for Flush<'_, Si, Item>

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

Important traits for Send<'_, Si, Item>

Important traits for SendAll<'_, Si, St>

ⓘImportant traits for Either<A, B>Important 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;fn left_sink<Si2>(self) -> Either<Self, Si2> where Si2: Sink<Item, SinkError = Self::SinkError>, Self: Sized, [src][+]

Important traits for Either<A, B>

ⓘImportant traits for Either<A, B>Important 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;fn right_sink<Si1>(self) -> Either<Si1, Self> where Si1: Sink<Item, SinkError = Self::SinkError>, Self: Sized, [src][+]

Important traits for Either<A, B>

fn compat(self) -> CompatSink<Self, Item> where Self: Sized + Unpin, [src][+]

impl<T> From for T[src][+]

fn from(t: T) -> T[src][+]

impl<T, U> Into for T where U: From<T>, [src][+]

fn into(self) -> U[src][+]

impl<T, U> TryFrom for T where U: Into<T>, [src][+]

type Error = Infallible

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

impl<T> Borrow for T where T: ?Sized, [src][+]

ⓘImportant traits for &'_ mut IImportant traits for &'_ mut Iimpl<'_, I> Iterator for &'_ mut I where I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;fn borrow(&self) -> &T[src][+]

Important traits for &'_ mut I

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

fn type_id(&self) -> TypeId[src][+]

impl<T> BorrowMut for T where T: ?Sized, [src][+]

Important traits for &'_ mut I

impl<T, U> TryInto for T where U: TryFrom<T>, [src][+]

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

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

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

`pub fn get_ref(&self) -> (&Si1, &Si2)`[src][+]

`pub fn get_mut(&mut self) -> (&mut Si1, &mut Si2)`[src][+]

`pub fn get_pin_mut<'a>( self: Pin<&'a mut Self> ) -> (Pin<&'a mut Si1>, Pin<&'a mut Si2>) where Si1: Unpin, Si2: Unpin,` [src][+]

`pub fn into_inner(self) -> (Si1, Si2)`[src][+]

`impl<Si1: Debug, Si2: Debug> Debug for Fanout<Si1, Si2>`[src][+]

`fn fmt(&self, f: &mut Formatter) -> FmtResult`[src][+]

`impl<Si1, Si2, Item> Sink<Item> for Fanout<Si1, Si2> where Si1: Sink<Item>, Item: Clone, Si2: Sink<Item, SinkError = Si1::SinkError>,` [src][+]

`type SinkError = Si1::SinkError`

`fn poll_ready( self: Pin<&mut Self>, cx: &mut Context ) -> Poll<Result<(), Self::SinkError>>`[src][+]

`fn start_send(self: Pin<&mut Self>, item: Item) -> Result<(), Self::SinkError>`[src][+]

`fn poll_flush( self: Pin<&mut Self>, cx: &mut Context ) -> Poll<Result<(), Self::SinkError>>`[src][+]

`fn poll_close( self: Pin<&mut Self>, cx: &mut Context ) -> Poll<Result<(), Self::SinkError>>`[src][+]

`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<T, Item> SinkExt 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::SinkError>, 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::SinkError>>, Self: Sized,` [src][+]

`fn sink_map_err<E, F>(self, f: F) -> SinkMapErr<Self, F> where F: FnOnce(Self::SinkError) -> E, Self: Sized,` [src][+]

`fn sink_err_into<E>(self) -> SinkErrInto<Self, Item, E> where Self: Sized, Self::SinkError: Into<E>,` [src][+]

`fn buffer(self, capacity: usize) -> Buffer<Self, Item> where Self: Sized,` [src][+]

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

`fn fanout<Si>(self, other: Si) -> Fanout<Self, Si> where Self: Sized, Item: Clone, Si: Sink<Item, SinkError = Self::SinkError>,` [src][+]

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

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

`fn compat(self) -> CompatSink<Self, Item> where Self: Sized + Unpin,` [src][+]

`impl<T> From for T`[src][+]

`fn from(t: T) -> T`[src][+]

`impl<T, U> Into for T where U: From<T>,` [src][+]

`fn into(self) -> U`[src][+]

`impl<T, U> TryFrom for T where U: Into<T>,` [src][+]

`type Error = Infallible`

`fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`[src][+]

`impl<T> Borrow for T where T: ?Sized,` [src][+]

`impl<T> Any for T where T: 'static + ?Sized,` [src][+]

`fn type_id(&self) -> TypeId`[src][+]

`impl<T> BorrowMut for T where T: ?Sized,` [src][+]

`impl<T, U> TryInto for T where U: TryFrom<T>,` [src][+]

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

`fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`[src][+]