Struct ContractCommand 

pub struct ContractCommand {
    pub wire_name: String,
    pub path: Vec<String>,
    pub verb: String,
    pub description: String,
    pub method: String,
    pub http_path: String,
    pub args: Vec<ContractArg>,
    pub examples: Vec<ContractExample>,
}

One command: where it sits, what it is called on the wire, how it is reached over HTTP, and what it accepts.

Fields

wire_name: String

Canonical identity, e.g. list_agents.

path: Vec<String>

Noun path from the root, e.g. ["agents", "versions"].

verb: String

Leaf verb, e.g. list.

description: String

method: String

HTTP method and path template, so a consumer holding only an API client can run the command without a hand-written implementation for it.

http_path: String

args: Vec<ContractArg>

examples: Vec<ContractExample>

Worked examples, rendered under the command’s help.

Not optional in practice: a guard asserts every routed command carries at least one, because a command surface an agent cannot learn from --help is one it will guess at instead.

Implementations

impl ContractCommand

pub fn after_help(&self) -> String

The block rendered under a command’s help: worked examples, then the flat name the same command answers to.

pub fn spelling(&self) -> String

Space-joined spelling, e.g. agents versions list.

pub fn clap_command(&self, display_name: &str) -> Command

The parser and the help for this command, as both consumers see it.

display_name is the spelling the caller typed, so usage and errors read back the grammar they used rather than a wire name they did not.

Trait Implementations

impl Clone for ContractCommand

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 ContractCommand

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ContractCommand

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ContractCommand

impl PartialEq for ContractCommand

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ContractCommand

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 ContractCommand