Struct CompletedStep 

pub struct CompletedStep<'owner> { /* private fields */ }

The event families produced by one world step that reached native simulation.

This capability owns a real exclusive borrow of the ordinary world or recording session which stepped it. It exposes no mutable world access, so Box2D’s transient event buffers remain valid until the capability ends. Dropping the value retires that state immediately; forgetting it is still harmless because the next owner operation retires it explicitly.

Self::post_step_error reports a callback, task, or recording-writer failure discovered after Box2D advanced. An outer error from World::step or RecordingSession::step therefore always means native simulation was not called.

Implementations

impl<'owner> CompletedStep<'owner>

pub const fn post_step_error(&self) -> Option<Error>

Returns a failure discovered after native simulation advanced.

Event families remain available for ordinary worlds. A recording-writer failure is sticky, so event materialization through that recording session also returns the writer error.

pub fn into_result(self) -> Result<Self>

Restores the traditional result-first projection.

On error this drops the completed-step capability and retires its transient outputs. Use Self::post_step_error when the caller must still publish events or synchronize state after native advancement.

pub fn body_events(&self) -> Result<BodyEvents<'_>>

Borrow mapped body-move events, fetching this native family at most once.

pub fn contact_events(&self) -> Result<ContactEventsView<'_>>

Borrow mapped contact events, fetching this native family at most once.

pub fn joint_events(&self) -> Result<JointEvents<'_>>

Borrow mapped joint events, fetching this native family at most once.

pub fn sensor_events(&self) -> Result<SensorEventsView<'_>>

Borrow mapped sensor events, fetching this native family at most once.

pub fn to_owned(&self) -> Result<StepEventsSnapshot>

Materialize every family and detach an owned snapshot from the world borrow.

Trait Implementations

impl Debug for CompletedStep<'_>

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

Formats the value using the given formatter.

impl Drop for CompletedStep<'_>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

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

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.