Struct TaskContext 

pub struct TaskContext {
    pub task_id: String,
    pub cancel_token: CancellationToken,
    /* private fields */
}

Context provided to every background task closure.

Bundles the cancellation token with an optional inbox sender so tasks can both respond to cancellation and push events to the owner agent.

Fields

task_id: String

Unique identifier of this task.

cancel_token: CancellationToken

Token that signals when the task should stop.

Implementations

impl TaskContext

pub fn emit(&self, event_type: &str, payload: Value) -> bool

Emit a custom event to the owner agent.

The event is delivered to the agent’s inbox and drained at step boundaries or when the agent is waiting for background tasks. Returns false if no inbox is bound or the agent has ended.

pub async fn cancelled(&self)

Wait until cancellation is requested.

Use this for tasks that do their work, emit a result, then park themselves until killed:

|ctx| async move {
    let result = do_work().await;
    ctx.emit("ready", serde_json::json!(result));
    ctx.cancelled().await;      // park until kill
    TaskResult::Cancelled
}

pub fn is_cancelled(&self) -> bool

Returns true if cancellation has been requested.

Trait Implementations

impl Clone for TaskContext

fn clone(&self) -> TaskContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.