Struct CommandDef 

pub struct CommandDef<C: Category, T: Tag, S: Scope> {
    pub name: &'static str,
    pub summary: &'static str,
    pub category: C,
    pub tags: &'static [T],
    pub scope: S,
    pub examples: &'static [Example],
    pub see_also: &'static [&'static str],
    pub long_description: &'static str,
    pub api: &'static [ApiEndpoint],
    pub confirmation: Option<Confirmation>,
}

Fields

name: &'static str

summary: &'static str

category: C

tags: &'static [T]

scope: S

examples: &'static [Example]

see_also: &'static [&'static str]

long_description: &'static str

Multi-paragraph explanation shown by the ? detail view. Lines are separated by \n. Empty string means no detail available.

api: &'static [ApiEndpoint]

HTTP API equivalents. Empty slice means CLI-only.

confirmation: Option<Confirmation>

Optional pre-invocation confirmation gate (CLI-only).

When set, the CLI dispatch layer should call Confirmation::prompt_stdio before running the command handler. The HTTP API ignores this field entirely.

Implementations

impl<C: Category, T: Tag, S: Scope> CommandDef<C, T, S>

pub fn requires_confirmation(&self) -> bool

Returns true if this command requires interactive confirmation before execution.

pub fn gate(&self) -> Result<bool>

Run the confirmation gate if one is defined.

Returns Ok(true) if no confirmation is needed or the user confirmed, Ok(false) if the user declined.

Trait Implementations

impl<C: Clone + Category, T: Clone + Tag, S: Clone + Scope> Clone for CommandDef<C, T, S>

fn clone(&self) -> CommandDef<C, T, S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<C: Copy + Category, T: Copy + Tag, S: Copy + Scope> Copy for CommandDef<C, T, S>

impl<C: Debug + Category, T: Debug + Tag, S: Debug + Scope> Debug for CommandDef<C, T, S>

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

Formats the value using the given formatter.