Struct TurnCompletion 

pub struct TurnCompletion { /* private fields */ }

Per-turn signals shared by the host and the engine.

Engine → host: whether the turn reached its NORMAL end — the final response came back un-cancelled and asked for no tools (nothing left to do). Set before the engine publishes that turn’s final MessageHistory. Done cannot say this: several cancelled paths also end Ok + Done. A host that cancels a turn reads it once the stream is drained: a turn that finished just before the cancel reached it (Esc a moment too late) is complete, not interrupted.

Host → engine: WHY the host cancelled the turn, noted before it cancels the token, so a canceled tool_result says so (“Canceled by user” only when it was the user). Nothing noted = the turn’s default cause: the user (the historical wording), or what the host chose at turn start (with_default_cause: a driver turn whose token something else cancels, e.g. the grant’s deadline, was cut by the driver ending).

Implementations

impl TurnCompletion

pub fn new() -> TurnCompletion

pub fn with_default_cause(cause: CancelCause) -> TurnCompletion

A turn whose un-noted cancels are cause’s (see the type docs).

pub fn completed(&self) -> bool

pub fn note_cancel_cause(&self, cause: CancelCause)

Note why the host is cancelling this turn. First cause wins: a teardown that revokes a driver and then cancels keeps its own cause.

Trait Implementations

impl Clone for TurnCompletion

fn clone(&self) -> TurnCompletion

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TurnCompletion

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

Formats the value using the given formatter.

impl Default for TurnCompletion

fn default() -> TurnCompletion

Returns the “default value” for a type.