Struct Future

pub struct Future { /* private fields */ }

A simple future which can complete once, and calls some callback(s) when it does so.

Clones can be made and all futures cloned from the same source will complete at the same time.

Implementations

impl Future

pub fn register_callback(&self, callback: Box<dyn FutureCallback>)

Registers a callback to be called upon completion of this future. If the future has already completed, the callback will be called immediately.

This is not exported to bindings users, use the bindings-only register_callback_fn instead

pub fn wait(self)

Waits until this Future completes.

pub fn wait_timeout(self, max_wait: Duration) -> bool

Waits until this Future completes or the given amount of time has elapsed.

Returns true if the Future completed, false if the time elapsed.

Trait Implementations

impl Clone for Future

fn clone(&self) -> Future

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Future for Future

This is not exported to bindings users as Rust Futures aren’t usable in language bindings.

type Output = ()

The type of value produced on completion.

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

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