Struct CliSpec 

pub struct CliSpec {
    pub schema: String,
    pub name: String,
    pub version: String,
    pub display_name: Option<String>,
    pub build: Option<String>,
    pub about: Option<String>,
    pub lifecycle_output: OutputSpec,
    pub exit_codes: Vec<ExitCodeSpec>,
    pub commands: Vec<CommandSpec>,
}

Serializable version-one closed-world CLI registry.

Fields

schema: String

name: String

version: String

display_name: Option<String>

Human-facing product name, distinct from the binary identity in name.

build: Option<String>

Opaque build identifier (a git SHA, for example). The core only carries it; what it means is the host’s business.

about: Option<String>

lifecycle_output: OutputSpec

exit_codes: Vec<ExitCodeSpec>

Exit codes this CLI returns beyond the 0/1/2 AFDATA defines, rendered into the reference’s exit-code table. Without this the published reference documents only AFDATA’s three, so a tool that also returns, say, a partial-success code ships a document that contradicts its own binary — on exactly the code a caller needs to branch on.

commands: Vec<CommandSpec>

Implementations

impl CliSpec

pub fn new(name: impl Into<String>, version: impl Into<String>) -> Self

Start a cli-spec-v1 registry.

pub fn about(self, about: impl Into<String>) -> Self

pub fn display_name(self, display_name: impl Into<String>) -> Self

pub fn build_id(self, build: impl Into<String>) -> Self

Record an opaque build identifier. Named build_id because build() already compiles the registry.

pub fn lifecycle_output(self, output: OutputSpec) -> Self

pub fn exit_code(self, code: u8, meaning: impl Into<String>) -> Self

Declare an exit code this CLI returns beyond AFDATA’s 0/1/2, so the rendered reference documents what the binary actually does.

pub fn command(self, command: CommandSpec) -> Self

pub fn build(self) -> Result<BuiltCliSpec, CliSpecError>

Validate and compile the registry.

Trait Implementations

impl Clone for CliSpec

fn clone(&self) -> CliSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CliSpec

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CliSpec

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CliSpec

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for CliSpec

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 CliSpec