Struct Running 

pub struct Running(/* private fields */);

Work running off the main thread for its entity, such as a tool call’s work: when it finishes, the kernel replaces it with its output in PollTasks, as a Done<T> or the component Running::spawn_into names, and observers of that component carry on. Bevy’s own pattern (examples/async_tasks/async_compute.rs): one task component for every kind of output, so no plugin registers a system for its own. Dropping it, or the entity, cancels the task; so does the app’s exit.

Implementations

impl Running

pub fn spawn<T: Send + Sync + 'static>( pool: &TaskPool, wake: &Wake, work: impl ConditionalSendFuture<Output = T> + 'static, ) -> Self

Spawns work on pool; it ends as a Done<T> on the entity, and wakes the loop.

pub fn spawn_into<C: Component + From<T>, T: Send + 'static>( pool: &TaskPool, wake: &Wake, work: impl ConditionalSendFuture<Output = T> + 'static, ) -> Self

Running::spawn, ending as the component C made from the output.

pub fn answering<T: Into<Outcome> + Send + 'static>( pool: &TaskPool, wake: &Wake, work: impl ConditionalSendFuture<Output = T> + 'static, ) -> Self

Spawns work on pool for the effect it goes on, such as an open tool call’s ToolResult; it ends as the effect’s stage::Outcome, unless something answered it first.

pub fn stream<T: Send + Sync + 'static>( pool: &TaskPool, wake: &Wake, items: impl Stream<Item = T> + ConditionalSend + 'static, ) -> Self

Spawns a task on pool that runs items to their end, such as a socket’s messages or a thread’s channel: each item is inserted on the entity as a Done<T>, in order, and wakes the loop; once the last one is in, Running is removed. Several items may come in one frame, so a reader observes Insert<Done<T>>, which sees each.

pub fn is_stream(&self) -> bool

Whether it is a Running::stream, a source that may never end, rather than work that finishes.

Trait Implementations

impl Component for Running

where Self: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have Component<Mutability = Mutable>, while immutable components will instead have Component<Mutability = Immutable>.

fn register_required_components( _requiree: ComponentId, required_components: &mut RequiredComponentsRegistrator<'_, '_>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn relationship_accessor() -> Option<ComponentRelationshipAccessor<Self>>

Returns ComponentRelationshipAccessor required for working with relationships in dynamic contexts.

fn on_add() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_add ComponentHook for this Component if one is defined.

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_insert ComponentHook for this Component if one is defined.

fn on_discard() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_discard ComponentHook for this Component if one is defined.

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_remove ComponentHook for this Component if one is defined.

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_despawn ComponentHook for this Component if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given EntityMapper. This is used to remap entities in contexts like scenes and entity cloning. When deriving Component, this is populated by annotating fields containing entities with #[entities]

const HAS_SUMMARY_TICK: bool = false

Set this constant to true if the component should track a summary tick.