Struct Command 

#[non_exhaustive]
pub struct Command {
    pub name: String,
    pub description: String,
    pub input: Option<AvailableCommandInput>,
    pub meta: Option<Map<String, Value>>,
}

Available on crate feature unstable_protocol_v2 only.

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

The type discriminator value is command.

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.

name: String

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

description: String

Human-readable description of what the command does.

input: Option<AvailableCommandInput>

Input for the command if required

Omitted and null are equivalent and mean the command takes no input.

meta: Option<Map<String, Value>>

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

See protocol docs: Extensibility

Implementations

impl Command

pub fn new(name: impl Into<String>, description: impl Into<String>) -> Command

Builds Command with the required fields set; optional fields start unset or empty.

pub fn input(self, input: impl IntoOption<AvailableCommandInput>) -> Command

Input for the command if required

pub fn meta(self, meta: impl IntoOption<Map<String, Value>>) -> Command

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 Command

fn clone(&self) -> Command

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Command

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Command

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Command

impl JsonSchema for Command

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 Command

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Command

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 Command