Struct Surface 

pub struct Surface {
    pub binary: String,
    pub mount: String,
    pub about: String,
    pub version: Option<String>,
    pub arguments: Vec<SurfaceArgument>,
    pub inherited_arguments: Vec<SurfaceArgument>,
    pub commands: Vec<SurfaceCommand>,
    pub usage_kdl: String,
    pub mount_line: String,
    pub notes: BTreeMap<String, String>,
}

Serializable operator-facing projection of one Clap command graph.

Fields

binary: String

Executable name declared by the root Clap command.

mount: String

Mise task name used for mounted invocations.

about: String

Root command description.

version: Option<String>

Root package version, when Clap declares one.

arguments: Vec<SurfaceArgument>

Arguments and flags declared directly on the root, in Clap order.

inherited_arguments: Vec<SurfaceArgument>

Ancestor global arguments, always empty for the root.

commands: Vec<SurfaceCommand>

Root subcommands in Clap declaration order, including hidden commands.

usage_kdl: String

Usage KDL for the mounted task name.

mount_line: String

Exact #USAGE mount line for a served mise task.

notes: BTreeMap<String, String>

Consumer-owned operator notes keyed for skill or instruction templates.

Implementations

impl Surface

pub fn new<C: CommandFactory>(mount: impl Into<String>) -> Self

Extract an operator surface from a Clap CommandFactory.

pub fn from_command(command: Command, mount: impl Into<String>) -> Self

Extract an operator surface from a Clap command graph.

pub fn note(self, name: impl Into<String>, value: impl Into<String>) -> Self

Add consumer-owned prose for a template audience or section.

pub fn long_options_without_short(&self) -> Vec<(String, String)>

Long flags that have no short, as (command path, long name).

The root path is empty. Inherited globals are not repeated on children. Hidden flags are included so a long-only option cannot hide from the check. FormatLong and ColorLong leave --format / --color without shorts on purpose; pass those names to Self::require_shorts.

pub fn require_shorts<'a>( &self, allow: impl IntoIterator<Item = &'a str>, ) -> Result<(), String>

Fail when a long option has no operator-visible short, except tokens in allow.

A root allowance is the displayed long option (--format). A nested allowance includes its command path (status --archived). Chassis mixins that deliberately leave a letter for the consumer (--format for -f/--file, --color for -c) belong there.

Trait Implementations

impl Clone for Surface

fn clone(&self) -> Surface

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Surface

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

Formats the value using the given formatter.

impl Eq for Surface

impl PartialEq for Surface

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Surface

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 Surface