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

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

This is supported on crate feature sink only.

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

[src]

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

[src]

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

Get a shared reference to the inner sinks.

[src]

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

Get a mutable reference to the inner sinks.

[src]

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

Get a pinned mutable reference to the inner sinks.

[src]

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

[src]

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

[src]

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

Formats the value using the given formatter. Read more

[src]

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::Error

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

[src]

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

[src]

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

[src]

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

Flush any remaining output from this sink. Read more

[src]

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

[src]

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

[src]

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

[src]

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

[src]

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

[src]

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

[src]

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

[src]

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

Mutably borrows from an owned value. Read more

[src]

impl<T> From<T> for T

[src]

pub fn from(t: T) -> T

Performs the conversion.

[src]

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

[src]

pub fn into(self) -> U

Performs the conversion.

[src]

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,

This is supported on crate feature sink only.

Composes a function in front of the sink. Read more

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

This is supported on crate feature sink only.

Composes a function in front of the sink. Read more

[src]

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

This is supported on crate feature sink only.

Transforms the error returned by the sink.

[src]

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

This is supported on crate feature sink only.

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

[src]

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

This is supported on crate feature sink only.

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

[src]

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,

This is supported on crate feature sink only.

Close the sink.

[src]

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

This is supported on crate feature sink only.

Fanout items to multiple sinks. Read more

[src]

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,

This is supported on crate feature sink only.

Flush the sink, processing all pending items. Read more

[src]

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,

This is supported on crate feature sink only.

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

[src]

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,

This is supported on crate feature sink only.

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

[src]

fn send_all<'a, St: ?Sized>(
    &'a mut self, 
    stream: &'a mut St
) -> SendAll<'a, Self, St>ⓘNotable 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>; where
    St: TryStream<Ok = Item, Error = Self::Error> + Stream + Unpin,
    Self: Unpin,

This is supported on crate feature sink only.

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

[src]

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,

This is supported on crate feature sink only.

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

[src]

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,

This is supported on crate feature sink only.

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

[src]

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

This is supported on crate features sink and compat only.

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

[src]

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

This is supported on crate feature sink only.

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

[src]

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

This is supported on crate feature sink only.

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

[src]

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

This is supported on crate feature sink only.

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

[src]

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

This is supported on crate feature sink only.

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

[src]

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

type Error = Infallible

The type returned in the event of a conversion error.

[src]

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

Performs the conversion.

[src]

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

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

The type returned in the event of a conversion error.

[src]

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

Performs the conversion.