Struct TimedAsyncTask

pub struct TimedAsyncTask<T: ConditionalSend> { /* private fields */ }

A wrapper type around an async future with a timeout. The future may be executed asynchronously by an TimedTaskRunner or TimedTaskPool bevy system parameter.

Implementations

impl<T> TimedAsyncTask<T>

where T: ConditionalSend + 'static,

pub fn new<F>(dur: Duration, fut: F) -> Self

where F: ConditionalSendFuture<Output = T> + 'static, F::Output: ConditionalSend + 'static,

Create an async task from a future with a timeout.

pub fn pending() -> Self

Never resolves to a value or becomes ready.

pub fn split( self, ) -> (Pin<Box<impl Future<Output = ()>>>, AsyncReceiver<Result<T, TimeoutError>>)

Split the task into a runnable future and receiver. This is a low-level operation and only useful for specific needs.

pub fn with_timeout(self, dur: Duration) -> Self

Replace the timeout for this task.

pub fn without_timeout(self) -> AsyncTask<T>

Remove the timeout for this task.

Trait Implementations

impl<T> Debug for TimedAsyncTask<T>

where T: Debug + Send,

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

Formats the value using the given formatter.

impl<T, Fnc> From<Fnc> for TimedAsyncTask<T>

where Fnc: ConditionalSendFuture<Output = T> + 'static, Fnc::Output: ConditionalSend + 'static,

fn from(value: Fnc) -> Self

Converts to this type from the input type.