Struct GroupSpec 

#[non_exhaustive]
pub struct GroupSpec {
    pub name: String,
    pub short: String,
    pub long: Option<String>,
    pub aliases: Vec<String>,
    pub hidden: bool,
    pub commands: Vec<CommandSpec>,
    pub groups: Vec<GroupSpec>,
    pub feature_flag: Option<FeatureFlag>,
}

Declarative command group metadata.

Groups are noun-based containers. They do not run business logic directly; when invoked bare, the CLI renders group help.

Construct with GroupSpec::new, then configure with the with_* builder methods — never as a struct literal. #[non_exhaustive] enforces this so the engine can add fields later without a breaking release.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

Group command name.

short: String

One-line group description.

long: Option<String>

Optional long help text.

aliases: Vec<String>

Alternate group names accepted by the parser.

hidden: bool

Whether the group runs but is hidden from discovery output.

commands: Vec<CommandSpec>

Declarative child commands used for static tree construction.

groups: Vec<GroupSpec>

Declarative nested groups used for static tree construction.

feature_flag: Option<FeatureFlag>

This group’s own feature-flag declaration, if any.

None means the group has no explicit stage declaration of its own, in which case it inherits its effective stage from its nearest ancestor (enclosing group, then module — nearest declaration wins), implicitly resolving to Stage::Ga if nothing in the ancestor chain declares a flag either; see Stage’s documentation for why that is its default. Set with with_feature_flag. This field only records the group’s own declaration; cascading resolution against the ancestor chain happens when a Cli mounts the enclosing module or parent group.

Implementations

impl GroupSpec

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

Creates a command group with the required name and one-line help.

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

Sets expanded group help.

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

Adds one group alias.

pub fn hidden(self, hidden: bool) -> Self

Hides or shows this group in discovery output.

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

Adds one declarative child command.

pub fn with_group(self, group: GroupSpec) -> Self

Adds one declarative nested group.

pub fn with_feature_flag(self, key: impl Into<String>, stage: Stage) -> Self

Declares this group’s own feature flag: the key used for policy overrides and introspection, and the stage at which it becomes visible.

pub fn clap_command(&self) -> Command

Builds the clap command for parser registration.

Trait Implementations

impl Clone for GroupSpec

fn clone(&self) -> GroupSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GroupSpec

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

Formats the value using the given formatter.

impl Default for GroupSpec

fn default() -> GroupSpec

Returns the “default value” for a type.