Struct arci::WaitFuture

pub struct WaitFuture { /* private fields */ }

Waits until the underlying future is complete.

Implementations

impl WaitFuture

pub fn new( future: impl Future<Output = Result<(), Error>> + Send + 'static, ) -> Self

Waits until the future is complete.

pub fn from_stream( stream: impl Stream<Item = Result<(), Error>> + Send + 'static, ) -> Self

Waits until the stream is complete.

Example

use arci::WaitFuture;
use futures::stream::FuturesOrdered;

let mut waits = FuturesOrdered::new();
waits.push(WaitFuture::ready());
waits.push(WaitFuture::ready());
WaitFuture::from_stream(waits).await?;

pub fn ready() -> Self

Creates a new WaitFuture which immediately complete.

Trait Implementations

impl Debug for WaitFuture

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

Formats the value using the given formatter.

impl From<Pin<Box<dyn Future<Output = Result<(), Error>> + Send>>> for WaitFuture

fn from(future: BoxFuture<'static, Result<(), Error>>) -> Self

Converts to this type from the input type.

impl Future for WaitFuture

type Output = Result<(), Error>

The type of value produced on completion.

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

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