Struct callback_future::CallbackFuture

pub struct CallbackFuture<T> { /* fields omitted */ }

An adapter between callbacks and futures.

Allows wrapping asynchronous API with callbacks into futures. Calls loader upon first Future::poll call; stores result and wakes upon getting callback.

Implementations

impl<T> CallbackFuture<T>

pub fn new(
    loader: impl FnOnce(Box<dyn FnOnce(T) + Send + 'static>) + Send + 'static
) -> CallbackFuture<T>

Creates a new CallbackFuture

Examples

use callback_future::CallbackFuture;
use futures::executor::block_on;
use std::thread;
use std::time::Duration;

let future = CallbackFuture::new(|complete| {
    // make call with callback here, call `complete` upon callback reception, e.g.:
    thread::spawn(move || {
        complete("Test");
    });
});
assert_eq!(block_on(future), "Test");

pub fn ready(value: T) -> CallbackFuture<T>

Creates a ready CallbackFuture

Examples

use callback_future::CallbackFuture;
use futures::executor::block_on;

assert_eq!(block_on(CallbackFuture::ready("Test")), "Test");

Trait Implementations

impl<T: Send + 'static> Future for CallbackFuture<T>

type Output = T

The type of value produced on completion.

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

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