Struct ThreadStatus 

pub(crate) struct ThreadStatus {
    stop: Arc<Stop>,
    state: Snapshot<WorldState>,
    own: SnapshotReader<WorldState>,
}

A cloneable view of a world’s state.

A WorldThread owns the join handle and stops its thread on drop; this shares only the stop signal and the state, so a WorldHandle can report a world’s state and ask it to stop without owning the thread. A caller reads that state through the handle, so this stays an implementation detail of the spawn functions.

Fields

stop: Arc<Stop>

The stop signal, sent on drop.

state: Snapshot<WorldState>

What the world is doing, and how it ended.

own: SnapshotReader<WorldState>

This status’s own reading of the state, for the tests that ask it directly instead of taking a reader.

Implementations

impl ThreadStatus

pub(crate) fn threaded(stop: Arc<Stop>) -> Self

A status for a world on a thread of its own, running from here.

pub(crate) fn detached() -> Self

A status for a world that shares its owner’s thread.

Such a world - a sub-world on the host, a runner of the caller’s own - ends when its owner says so, so the state stays WorldState::Running until then, and the stop signal belongs to that owner alone.

fn at(stop: Arc<Stop>) -> Self

pub(crate) fn state(&self) -> SnapshotReader<WorldState>

A reader of the state this world publishes.

Every reader sees the newest state, so one that arrives late still learns how the world ended.

pub(crate) fn is_finished(&self) -> bool

Whether the world has stopped or died.

A detached thread keeps reporting its own end, so this stays meaningful after WorldThread::detach.

pub(crate) fn stop(&self)

Ask the world to stop, without waiting for it to finish.

pub(crate) fn stop_requested(&self) -> bool

Whether the world has been asked to stop.

A world on its own thread reads this from its tick loop; a world the host drives reads it when the host drains it.

pub(crate) fn finish(&self)

Mark the world as finished.

A world on its own thread marks itself when its loop ends; a stepped world’s host calls this when its tick returns false, and a world dropped by its owner marks itself as it goes. A world that has already ended keeps the state it ended with: a panic stays the last word.

pub(crate) fn record_panic(&self, message: String)

Record the panic that ended the world, message and all.

Trait Implementations

impl Clone for ThreadStatus

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.