Struct TurnScope 

pub struct TurnScope { /* private fields */ }

One turn’s cancellable scope. Construct once per SubmitPrompt; abandon (drop) at the end of the turn.

Implementations

impl TurnScope

pub fn new(id: TurnId) -> Self

pub fn id(&self) -> TurnId

pub fn token(&self) -> CancellationToken

Clone the scope’s token. Hand this to child tasks so they can participate in cooperative cancellation.

pub fn background_token(&self) -> CancellationToken

Clone the scope’s background-request token (Ctrl+B). Tools that can detach a running child select on this instead of killing it.

pub fn background(&self)

Signal “background the running work” to every child task that listens.

pub fn spawn<Fut>(&mut self, fut: Fut) -> AbortHandle

where Fut: Future<Output = ()> + Send + 'static,

Spawn a child task under this scope. The returned handle is retained inside the scope’s JoinSet — callers don’t need to keep it. Cancellation of the scope aborts the task at its next await.

pub fn cancel(&self)

Signal cancellation to every child task. Returns immediately — callers drain the JoinSet separately via drain_completed.

pub fn is_cancelled(&self) -> bool

True iff the scope has been cancelled.

pub async fn join_next(&mut self) -> Option<Result<(), JoinError>>

Join one task if any has completed. Returns None immediately when the set is empty or nothing is ready. Intended for the main loop’s per-tick bookkeeping — not a blocking drain.

pub fn is_empty(&self) -> bool

True iff no child task is currently running inside this scope. The main loop uses this after a cancel() to decide when to transition from TurnState::Cancelling back to Idle.

pub fn drain_completed(&mut self)

Drain any already-completed tasks from the JoinSet without blocking. JoinSet::is_empty only flips to true after finished tasks are explicitly harvested via join_next; without this, EffectRunner::reap_empty_scopes would see finished-but-not- joined scopes as “still busy” and never reap them. F12.

pub fn len(&self) -> usize

pub async fn drain(&mut self)

Await every outstanding task to completion, swallowing JoinErrors (they happen on normal abort()s after cancellation). Use during shutdown.

Trait Implementations

impl Debug for TurnScope

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

Formats the value using the given formatter.

impl Drop for TurnScope

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.