Struct FutureQueue 

pub struct FutureQueue { /* private fields */ }

A queue for polling futures. It is stored in here until FutureQueue::poll is run.

Implementations

impl FutureQueue

pub fn new() -> Self

Creates a new Arc<FutureQueue>.

pub fn push<F, T>(&self, future: F) -> FutureHandle

where F: Future<Output = T> + Send + 'static, T: Send + Sync + 'static,

Pushes a future to the FutureQueue. It will sit and wait to be processed until FutureQueue::poll is called.

pub fn poll(&self)

Polls all the futures in the future queue and resolves the handles.

This function spawns a new async thread for each item inside the thread and sends updates to the Handle’s receiver.

pub fn exchange(&self, handle: &FutureHandle) -> Option<AnyResult>

Exchanges the future for the result.

When the handle is not successful, it will return nothing. When the handle is successful, it will return the result. The result is cached and can be retrieved multiple times.

pub fn exchange_owned(&self, handle: &FutureHandle) -> Option<AnyResult>

Exchanges the future for the result, taking ownership and consuming the cached result.

When the handle is not successful, it will return nothing. When the handle is successful, it will return the result and remove it from the cache, allowing Arc::try_unwrap to succeed. This method can only be called once per completed future.

pub fn exchange_as<T: Any + Send + Sync + 'static>( &self, handle: &FutureHandle, ) -> Option<T>

Exchanges the handle and safely downcasts it into a specific type.

pub fn exchange_owned_as<T: Any + Send + Sync + 'static>( &self, handle: &FutureHandle, ) -> Option<T>

Exchanges the handle taking ownership and safely downcasts it into a specific type. This method consumes the cached result, allowing Arc::try_unwrap to succeed.

pub fn get_status(&self, handle: &FutureHandle) -> Option<FutureStatus>

Get status of a handle

pub fn cleanup(&self)

Cleans up any completed handles and removes them from the registry.

You can do this manually, however this is typically done at the end of the frame.

Trait Implementations

impl Default for FutureQueue

fn default() -> Self

Returns the “default value” for a type.