Struct bevy_internal::tasks::Task

source · [−]

pub struct Task<T>(_);

Expand description

Wraps async_executor::Task, a spawned future.

Tasks are also futures themselves and yield the output of the spawned future.

When a task is dropped, its gets canceled and won’t be polled again. To cancel a task a bit more gracefully and wait until it stops running, use the cancel() method.

Tasks that panic get immediately canceled. Awaiting a canceled task also causes a panic. Wraps async_executor::Task

Implementations

source

impl<T> Task<T>

source

pub fn new(task: Task<T>) -> Task<T>ⓘNotable traits for Task<T>`impl<T> Future for Task<T> type Output = T;`

Creates a new task from a given async_executor::Task

source

pub fn detach(self)

Detaches the task to let it keep running in the background. See async_executor::Task::detach

source

pub async fn cancel(self) -> Option<T>

Cancels the task and waits for it to stop running.

Returns the task’s output if it was completed just before it got canceled, or None if it didn’t complete.

While it’s possible to simply drop the Task to cancel it, this is a cleaner way of canceling because it also waits for the task to stop running.

See async_executor::Task::cancel

Trait Implementations

source

impl<T> Component for Task<T> where
 Task<T>: 'static,
 Task<T>: Send,
 Task<T>: Sync,

type Storage = TableStorage

source

impl<T> Debug for Task<T> where
T: Debug,

source

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

Formats the value using the given formatter. Read more

source

impl<T> Future for Task<T>

type Output = T

The type of value produced on completion.

source

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

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

Auto Trait Implementations

impl<T> RefUnwindSafe for Task<T>

impl<T> Send for Task<T> where
T: Send,

impl<T> Sync for Task<T>

impl<T> Unpin for Task<T>

impl<T> UnwindSafe for Task<T>

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> Downcast for T where
T: Any,

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s. Read more

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s. Read more

impl<T> DowncastSync for T where
T: Any + Send + Sync,

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send + 'static>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<F> FutureExt for F where
F: Future + ?Sized,

fn poll(&mut self, cx: &mut Context<'_>) -> Poll<Self::Output> where
Self: Unpin,

A convenience for calling Future::poll() on !Unpin types.

fn or<F>(self, other: F) -> Or<Self, F> where
F: Future<Output = Self::Output>,

Returns the result of self or other future, preferring self if both are ready. Read more

fn race<F>(self, other: F) -> Race<Self, F> where
F: Future<Output = Self::Output>,

Returns the result of self or other future, with no preference if both are ready. Read more

fn catch_unwind(self) -> CatchUnwind<Self> where
Self: UnwindSafe,

Catches panics while polling the future. Read more

fn boxed<'a>(
self
) -> Pin<Box<dyn Future<Output = Self::Output> + Send + 'a, Global>> where
Self: 'a + Send,

Boxes the future and changes its type to dyn Future + Send + 'a. Read more

fn boxed_local<'a>(
self
) -> Pin<Box<dyn Future<Output = Self::Output> + 'a, Global>> where
Self: 'a,

Boxes the future and changes its type to dyn Future + 'a. Read more

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>`impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;`

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>`impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;`

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<F> IntoFuture for F where
F: Future,

type Output = <F as Future>::Output

🔬 This is a nightly-only experimental API. (into_future)

The output that the future will produce on completion.

type IntoFuture = F

🔬 This is a nightly-only experimental API. (into_future)

Which kind of future are we turning this into?

source

fn into_future(self) -> <F as IntoFuture>::IntoFuture

🔬 This is a nightly-only experimental API. (into_future)

Creates a future from a value.

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

impl<F, T, E> TryFuture for F where
F: Future<Output = Result<T, E>> + ?Sized,

type Ok = T

The type of successful values yielded by this future

type Error = E

The type of failures yielded by this future

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

Poll this TryFuture as if it were a Future. Read more

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>`impl<T> Future for WithDispatch<T> where T: Future, type Output = <T as Future>::Output;` where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>`impl<T> Future for WithDispatch<T> where T: Future, type Output = <T as Future>::Output;`

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

source

Struct bevy_internal::tasks::Task

Implementations

impl<T> Task<T>

pub fn new(task: Task<T>) -> Task<T>ⓘNotable traits for Task<T>impl<T> Future for Task<T> type Output = T;

pub fn detach(self)

pub async fn cancel(self) -> Option<T>

Trait Implementations

impl<T> Component for Task<T> where Task<T>: 'static, Task<T>: Send, Task<T>: Sync,

type Storage = TableStorage

impl<T> Debug for Task<T> where T: Debug,

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

impl<T> Future for Task<T>

type Output = T

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

Auto Trait Implementations

impl<T> RefUnwindSafe for Task<T>

impl<T> Send for Task<T> where T: Send,

impl<T> Sync for Task<T>

impl<T> Unpin for Task<T>

impl<T> UnwindSafe for Task<T>

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> Downcast for T where T: Any,

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

fn as_any(&self) -> &(dyn Any + 'static)

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

impl<T> DowncastSync for T where T: Any + Send + Sync,

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send + 'static>

impl<T> From<T> for T

fn from(t: T) -> T

impl<F> FutureExt for F where F: Future + ?Sized,

fn poll(&mut self, cx: &mut Context<'_>) -> Poll<Self::Output> where Self: Unpin,

fn or<F>(self, other: F) -> Or<Self, F> where F: Future<Output = Self::Output>,

fn race<F>(self, other: F) -> Race<Self, F> where F: Future<Output = Self::Output>,

fn catch_unwind(self) -> CatchUnwind<Self> where Self: UnwindSafe,

fn boxed<'a>( self) -> Pin<Box<dyn Future<Output = Self::Output> + Send + 'a, Global>> where Self: 'a + Send,

fn boxed_local<'a>( self) -> Pin<Box<dyn Future<Output = Self::Output> + 'a, Global>> where Self: 'a,

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;

fn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<F> IntoFuture for F where F: Future,

type Output = <F as Future>::Output

type IntoFuture = F

fn into_future(self) -> <F as IntoFuture>::IntoFuture

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<F, T, E> TryFuture for F where F: Future<Output = Result<T, E>> + ?Sized,

type Ok = T

type Error = E

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

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for T where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where T: Future, type Output = <T as Future>::Output; where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where T: Future, type Output = <T as Future>::Output;

impl<T> Resource for T where T: 'static + Send + Sync,

pub fn new(task: Task<T>) -> Task<T>ⓘNotable traits for Task<T>`impl<T> Future for Task<T> type Output = T;`

impl<T> Component for Task<T> where
Task<T>: 'static,
Task<T>: Send,
Task<T>: Sync,

impl<T> Debug for Task<T> where
T: Debug,

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

impl<T> Send for Task<T> where
T: Send,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T> Downcast for T where
T: Any,

impl<T> DowncastSync for T where
T: Any + Send + Sync,

impl<F> FutureExt for F where
F: Future + ?Sized,

fn poll(&mut self, cx: &mut Context<'_>) -> Poll<Self::Output> where
Self: Unpin,

fn or<F>(self, other: F) -> Or<Self, F> where
F: Future<Output = Self::Output>,

fn race<F>(self, other: F) -> Race<Self, F> where
F: Future<Output = Self::Output>,

fn catch_unwind(self) -> CatchUnwind<Self> where
Self: UnwindSafe,

fn boxed<'a>(
self
) -> Pin<Box<dyn Future<Output = Self::Output> + Send + 'a, Global>> where
Self: 'a + Send,

fn boxed_local<'a>(
self
) -> Pin<Box<dyn Future<Output = Self::Output> + 'a, Global>> where
Self: 'a,

fn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>`impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;`

fn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>`impl<T> Future for Instrumented<T> where T: Future, type Output = <T as Future>::Output;`

impl<T, U> Into<U> for T where
U: From<T>,

impl<F> IntoFuture for F where
F: Future,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<F, T, E> TryFuture for F where
F: Future<Output = Result<T, E>> + ?Sized,

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

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>`impl<T> Future for WithDispatch<T> where T: Future, type Output = <T as Future>::Output;` where
S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>`impl<T> Future for WithDispatch<T> where T: Future, type Output = <T as Future>::Output;`

impl<T> Resource for T where
T: 'static + Send + Sync,