futures_time::future

Trait IntoFuture

Source 
pub trait IntoFuture {
    type Output;
    type IntoFuture: Future<Output = Self::Output>;

    // Required method
    fn into_future(self) -> Self::IntoFuture;
}
Expand description

Conversion into a Future.

By implementing Intofuture for a type, you define how it will be converted to a future. This is common for types which describe an asynchronous builder of some kind.

One benefit of implementing IntoFuture is that your type will work with Rust’s .await syntax.

§Examples

Basic usage:

use futures_time::future::IntoFuture;

let v = async { "meow" };
let mut fut = v.into_future();
assert_eq!("meow", fut.await);

It is common to use IntoFuture as a trait bound. This allows the input type to change, so long as it is still a future. Additional bounds can be specified by restricting on Output:

use futures_time::future::IntoFuture;
async fn fut_to_string<Fut>(fut: Fut) -> String
where
    Fut: IntoFuture,
    Fut::Output: std::fmt::Debug,
{
    format!("{:?}", fut.into_future().await)
}

Required Associated Types§

Source

type Output

The output that the future will produce on completion.

Source

type IntoFuture: Future<Output = Self::Output>

Which kind of future are we turning this into?

Required Methods§

Source

fn into_future(self) -> Self::IntoFuture

Creates a future from a value.

§Examples

Basic usage:

use futures_time::future::IntoFuture;

let v = async { "meow" };
let mut fut = v.into_future();
assert_eq!("meow", fut.await);

Implementors§