Struct all_is_cubes::behavior::BehaviorContext

#[non_exhaustive]
pub struct BehaviorContext<'a, H: BehaviorHost> {
    pub tick: Tick,
    pub host: &'a H,
    pub attachment: &'a H::Attachment,
    /* private fields */
}

Items available to a Behavior during Behavior::step().

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

tick: Tick

The time tick that is currently passing, causing this step.

host: &'a H

The current state of the behavior’s host object.

attachment: &'a H::Attachment

Additional data about “where” the behavior is attached to the host; what part of the host should be affected by the behavior.

Implementations

impl<'a, H: BehaviorHost> BehaviorContext<'a, H>

pub fn waker(&self) -> &'a BehaviorWaker

Returns a waker that should be used to signal when the behavior’s step() should be called again, in the case where it returns Then::Sleep.

This is precisely analogous to the use of Waker with Future::poll(); see the comment on BehaviorWaker for the rationale for not being a Waker.

pub fn bind_host(&self, transaction: H::Transaction) -> UniverseTransaction

Take a transaction applicable to the behavior’s host, and wrap it to become a UniverseTransaction for the host’s containing universe.

pub fn replace_self<B: Behavior<H> + 'static>( &self, new_behavior: B, ) -> UniverseTransaction

Returns a transaction which will replace this behavior with a new value.

This should be used whenever a behavior wishes to modify itself, to ensure that the modification only takes effect when the behavior’s other effects do.

Trait Implementations

impl<'a, H: BehaviorHost + Debug> Debug for BehaviorContext<'a, H>

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

Formats the value using the given formatter.