Struct Descriptor 

pub struct Descriptor {
    pub id: String,
    pub summary: String,
    pub long: String,
    pub privileged: bool,
    pub output_kind: String,
    pub inputs: Vec<Input>,
    pub flags: Vec<String>,
    pub examples: Vec<String>,
}

A complete description of one capability.

Fields

id: String

Dotted capability id (e.g. services.start).

summary: String

One-line human summary (maps to clap about).

long: String

Full description (maps to clap long_about).

privileged: bool

Whether invoking the capability requires elevated privileges.

output_kind: String

The envelope kind this capability emits.

inputs: Vec<Input>

Inputs the capability accepts.

flags: Vec<String>

Flags the capability honors.

examples: Vec<String>

Example invocations (maps to clap after_help).

Implementations

impl Descriptor

pub fn render_text(&self) -> String

Render the descriptor as a complete plain-text block for fez describe (no --json).

Top-level help promises describe prints inputs, output kind, flags, and privileged status; this carries the same essential metadata the JSON form does so an agent reading text output can act safely without switching to JSON (issue #62).

Trait Implementations

impl Clone for Descriptor

fn clone(&self) -> Descriptor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Serialize for Descriptor

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.