Struct Wake 

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

A shared signal requesting another app update, raised by completed tasks, stream delivery, or host systems needing a later pass. Each signal advances Wake::generation and wakes blocking and async waiters; signalling requires only shared access to the resource.

Implementations

impl Wake

pub fn signal(&self)

Raise the signal.

pub fn generation(&self) -> u64

Return the wrapping count of signals raised.

pub fn take(&self) -> bool

Take the signal: whether it was raised since the last take.

pub fn wait(&self, timeout: Duration) -> bool

Block until the signal is raised or timeout elapses, then take it. Returns whether it was raised.

pub fn woken(&self) -> impl Future<Output = ()> + Send + '_

Resolve when the signal is raised, taking it.

Trait Implementations

impl Clone for Wake

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for Wake

where Self: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::SparseSet

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]

impl Default for Wake

fn default() -> Self

Returns the “default value” for a type.

impl Resource for Wake

where Self: Send + Sync + 'static,