Enum BackgroundWork 

#[non_exhaustive]
pub enum BackgroundWork {
    Terminal(BackgroundTerminal),
    ToolCall(BackgroundToolCall),
    Subagent(BackgroundSubagent),
    Other(OtherBackgroundWork),
}

Available on crate feature unstable_protocol_v2 only.

One piece of work running independently of the session’s foreground work.

Items reference entities the Client already tracks. The Agent MUST announce each item before the first snapshot that lists it, and MUST report a terminal’s exitStatus or a tool call’s final status before the snapshot that removes it. Each piece of work is listed once: process-backed work is listed as its terminal, not also as its tool call.

See protocol docs: Background Work

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Terminal(BackgroundTerminal)

A process that keeps running after its tool call returned control to the model. Live until its terminal_update reports exitStatus.

ToolCall(BackgroundToolCall)

Work started by a tool call that continues without a process of its own, such as a watcher, a workflow, or a scheduled wakeup. pending and paused tool calls stay listed.

Subagent(BackgroundSubagent)

Available on crate feature unstable_subagents only.

UNSTABLE

This capability is not part of the spec yet, and may be removed or changed at any point.

A detached subagent session that has anything running: its state is not idle, or its own background list is non-empty or not reported.

Other(OtherBackgroundWork)

Custom or future background work.

Values beginning with _ are reserved for implementation-specific extensions. Unknown values that do not begin with _ are reserved for future ACP variants.

An unknown item still means background work is running, even when the Client cannot show what it is.

Trait Implementations

impl Clone for BackgroundWork

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BackgroundWork

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BackgroundWork

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for BackgroundWork

impl JsonSchema for BackgroundWork

Available on crate feature schemars only.

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for BackgroundWork

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for BackgroundWork

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for BackgroundWork