Struct CommandCatalogEntry 

pub struct CommandCatalogEntry {

    pub path: Vec<String>,
    pub display: String,
    pub aliases: Vec<String>,
    pub tier: String,
    pub surface: String,
    pub help_visibility: String,
    pub help_rank: u16,
    pub canonical_command: Option<String>,
    pub canonical_action: Option<CanonicalAction>,
    pub command_action: Option<CommandAction>,
    pub summary: String,
    pub has_subcommands: bool,
    pub supports_json: bool,
    pub output_modes: Vec<String>,
    pub mutates: bool,
    pub supports_op_id: bool,
    pub persists_op_id: bool,
    pub op_id_behavior: String,
    pub op_id_store_scope: String,
    pub observe_only: bool,
    pub may_initialize: bool,
    pub may_import_git: bool,
    pub may_write_worktree: bool,
    pub may_move_ref: bool,
    pub destructive_requires_force: bool,
    pub writes_heddle_refs: bool,
    pub writes_git_refs: bool,
    pub writes_worktree: bool,
    pub writes_config: bool,
    pub writes_hooks: bool,
    pub network_io: bool,
    pub daemon_process: bool,
    pub object_gc: bool,
    pub external_command: bool,
    pub requires_git_executable: bool,
    pub destructive_data: bool,
    pub side_effects: Vec<CommandSideEffect>,
    pub side_effect_class: String,
    pub first_run_behavior: String,
    pub json_kind: String,
    pub json_discriminators: Vec<CommandJsonDiscriminator>,
    pub schema_verbs: Vec<String>,
    pub documented_schema_verbs: Vec<String>,
    pub options: Vec<CommandCatalogOption>,
    pub arguments: Vec<CommandCatalogArgument>,
    pub exit_codes: Vec<CommandCatalogExitCode>,
}

Fields

path: Vec<String>

display: String

aliases: Vec<String>

tier: String

surface: String

help_visibility: String

help_rank: u16

canonical_command: Option<String>

canonical_action: Option<CanonicalAction>

command_action: Option<CommandAction>

summary: String

has_subcommands: bool

supports_json: bool

output_modes: Vec<String>

mutates: bool

supports_op_id: bool

persists_op_id: bool

op_id_behavior: String

op_id_store_scope: String

observe_only: bool

may_initialize: bool

may_import_git: bool

may_write_worktree: bool

may_move_ref: bool

destructive_requires_force: bool

writes_heddle_refs: bool

writes_git_refs: bool

writes_worktree: bool

writes_config: bool

writes_hooks: bool

network_io: bool

daemon_process: bool

object_gc: bool

external_command: bool

requires_git_executable: bool

destructive_data: bool

side_effects: Vec<CommandSideEffect>

side_effect_class: String

first_run_behavior: String

json_kind: String

json_discriminators: Vec<CommandJsonDiscriminator>

schema_verbs: Vec<String>

documented_schema_verbs: Vec<String>

options: Vec<CommandCatalogOption>

arguments: Vec<CommandCatalogArgument>

exit_codes: Vec<CommandCatalogExitCode>

Sysexits-style codes this command may legitimately return, with a one-line agent-facing reason. Empty for commands not yet swept. See docs/exit-codes.md for the full taxonomy.

Trait Implementations

impl Clone for CommandCatalogEntry

fn clone(&self) -> CommandCatalogEntry

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommandCatalogEntry

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

Formats the value using the given formatter.

impl JsonSchema for CommandCatalogEntry

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for CommandCatalogEntry

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.