Struct futures_util::stream::Forward

[+] Show declaration

[+] Expand attributes
#[must_use = "steams do nothing unless polled"]
pub struct Forward<St: Stream, Si: Sink + Unpin> { /* fields omitted */ }

[−] Expand description

Future for the Stream::forward combinator, which sends a stream of values to a sink and then flushes the sink.

Note: this is only usable with Unpin sinks, so Sinks that aren't Unpin will need to be pinned in order to be used with this combinator.

Trait Implementations

impl<St: Debug + Stream, Si: Debug + Sink + Unpin> Debug for Forward<St, Si> where     Si::SinkItem: Debug,

[+]

fn fmt(&self, f: &mut Formatter) -> Result

[−]

Formats the value using the given formatter.

impl<St: Stream + Unpin, Si: Sink + Unpin> Unpin for Forward<St, Si>

impl<St, Si> Future for Forward<St, Si> where     Si: Sink + Unpin,     St: Stream<Item = Result<Si::SinkItem, Si::SinkError>>,

[+]

type Output = Result<Si, Si::SinkError>

🔬 This is a nightly-only experimental API. (futures_api)

futures in libcore are unstable

The result of the Future.

fn poll(self: PinMut<Self>, cx: &mut Context) -> Poll<Self::Output>

[−]

🔬 This is a nightly-only experimental API. (futures_api)

futures in libcore are unstable

Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.