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

#[must_use = "sinks do nothing unless polled"]
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(self: Pin<&mut Self>) -> (Pin<&mut Si1>, Pin<&mut Si2>)`[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]

`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, Error = Si1::Error>,` [src]

`type Error = Si1::Error`

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::Error>>`[src]

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

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

`fn poll_close( self: Pin<&mut Self>, cx: &mut Context ) -> Poll<Result<(), Self::Error>>`[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,`

`impl<Si1, Si2> Unpin for Fanout<Si1, Si2> where Si1: Unpin, Si2: Unpin,`

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

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

Blanket Implementations

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

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

`fn sink_err_into<E>(self) -> SinkErrInto<Self, Item, E> where Self: Sized, Self::Error: 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::Error>;`
`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, Error = Self::Error>,` [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::Error>;`
`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::Error>;`
`fn send(&mut self, item: Item) -> Send<Self, Item> where Self: Unpin,` [src]

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

ⓘ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, Error = Self::Error>, Self: Sized,` [src]

ⓘ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, Error = Self::Error>, Self: Sized,` [src]

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

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

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

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

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

`type Error = !`

The type returned in the event of a conversion error.

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

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

`type Error = >::Error`

The type returned in the event of a conversion error.

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

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

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

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

ⓘImportant traits for &'_ mut F
Important traits for &'_ mut F
`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> Any for T where T: 'static + ?Sized,` [src]

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

[−][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(self: Pin<&mut Self>) -> (Pin<&mut Si1>, Pin<&mut Si2>)[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, Error = Si1::Error>, [src]

type Error = Si1::Error

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

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

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

fn poll_close( self: Pin<&mut Self>, cx: &mut Context) -> Poll<Result<(), Self::Error>>[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,

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

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

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

Blanket Implementations

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

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

fn sink_err_into<E>(self) -> SinkErrInto<Self, Item, E> where Self: Sized, Self::Error: 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::Error>;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, Error = Self::Error>, [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::Error>;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::Error>;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, Error = Self::Error>, 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, Error = Self::Error>, Self: Sized, [src]

Important traits for Either<A, B>

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

fn into(self) -> U[src]

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

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

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

type Error = !

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

impl<T, U> TryInto<U> 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<T> Borrow<T> for T where T: ?Sized, [src]

ⓘImportant traits for &'_ mut FImportant traits for &'_ mut Fimpl<'_, 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 F

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

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