Enum AvailableCommand 

#[non_exhaustive]
pub enum AvailableCommand {
    Command(Command),
    Other(OtherAvailableCommand),
}

Available on crate feature unstable_protocol_v2 only.

A command the agent advertises to the client.

The type field acts as the discriminator in the serialized JSON form.

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.

Command(Command)

A slash command the user can invoke by including it in a prompt.

Other(OtherAvailableCommand)

Custom or future command kind.

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

Clients that do not understand this command type should preserve the raw payload when storing, replaying, proxying, or forwarding command metadata, and otherwise ignore the command or display it as a plain command using its name and description.

Implementations

impl AvailableCommand

pub fn name(&self) -> &str

Command name (e.g., create_plan, research_codebase).

pub fn description(&self) -> &str

Human-readable description of what the command does.

pub fn meta(&self) -> Option<&Map<String, Value>>

The _meta property is reserved by ACP to allow clients and agents to attach additional metadata to their interactions. Implementations MUST NOT make assumptions about values at these keys.

See protocol docs: Extensibility

Trait Implementations

impl Clone for AvailableCommand

fn clone(&self) -> AvailableCommand

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AvailableCommand

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AvailableCommand

fn deserialize<__D>( __deserializer: __D, ) -> Result<AvailableCommand, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for AvailableCommand

impl JsonSchema for AvailableCommand

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 AvailableCommand

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for AvailableCommand

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for AvailableCommand