Struct TerminalUpdate 

#[non_exhaustive]
pub struct TerminalUpdate {
    pub terminal_id: TerminalId,
    pub command: MaybeUndefined<String>,
    pub cwd: MaybeUndefined<AbsolutePath>,
    pub output: MaybeUndefined<TerminalOutput>,
    pub exit_status: MaybeUndefined<TerminalExitStatus>,
    pub meta: MaybeUndefined<Meta>,
}

Available on crate feature unstable_protocol_v2 only.

An upsert for the stored state of an agent-owned terminal.

Only TerminalUpdate::terminal_id is required. Other fields have patch semantics: omitted fields leave the stored value unchanged, null clears it, and concrete values replace it. A concrete _meta object instead patches the stored metadata by top-level key. When the terminal ID is new, omitted fields start unknown.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

terminal_id: TerminalId

Unique identifier for this terminal within the session.

command: MaybeUndefined<String>

The command being run.

cwd: MaybeUndefined<AbsolutePath>

The absolute working directory of the command.

output: MaybeUndefined<TerminalOutput>

An authoritative replacement snapshot of terminal output bytes.

exit_status: MaybeUndefined<TerminalExitStatus>

Exit information. A concrete object marks the terminal as exited.

meta: MaybeUndefined<Meta>

The _meta property is reserved by ACP to allow clients and agents to attach additional metadata to their interactions. Omitted leaves the stored metadata unchanged; null clears it. An object patches the stored metadata by top-level key: keys it omits are unchanged, a key set to null is removed, and any other value replaces that key’s stored value without merging nested objects. Beyond this patch rule, implementations MUST NOT make assumptions about values at these keys.

See protocol docs: Metadata Patches

Implementations

impl TerminalUpdate

pub fn new(terminal_id: impl Into<TerminalId>) -> Self

Builds a terminal upsert with only its required ID set.

pub fn command(self, command: impl IntoMaybeUndefined<String>) -> Self

Sets, clears, or leaves unchanged the command being run.

pub fn cwd(self, cwd: impl IntoMaybeUndefined<AbsolutePath>) -> Self

Sets, clears, or leaves unchanged the absolute working directory.

pub fn output(self, output: impl IntoMaybeUndefined<TerminalOutput>) -> Self

Sets, clears, or leaves unchanged the authoritative output snapshot.

pub fn exit_status( self, exit_status: impl IntoMaybeUndefined<TerminalExitStatus>, ) -> Self

Sets, clears, or leaves unchanged the terminal exit information.

pub fn meta(self, meta: impl IntoMaybeUndefined<Meta>) -> Self

Patches, clears, or leaves unchanged terminal metadata.

A concrete object patches stored metadata by top-level key; see apply_meta_update.

pub fn apply_update(&mut self, update: TerminalUpdate)

Applies a later terminal patch to this stored terminal state.

Fields set to null remain null so callers can distinguish explicit clearing from an update that did not mention the field. A concrete _meta object patches the stored metadata by top-level key, as described by apply_meta_update.

Trait Implementations

impl Clone for TerminalUpdate

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 TerminalUpdate

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TerminalUpdate

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for TerminalUpdate

impl JsonSchema for TerminalUpdate

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 TerminalUpdate

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for TerminalUpdate

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 TerminalUpdate