Struct Module 

pub struct Module {
    pub category: String,
    pub guides: Vec<GuideEntry>,
    pub views: Vec<HumanViewDef>,
    pub register: ModuleRegister,
}

Domain-bounded unit of CLI functionality.

A module usually maps to a product, platform, resource family, or team ownership boundary. It contributes one top-level group plus optional guides and human output views.

Fields

category: String

Root help category.

guides: Vec<GuideEntry>

Guide entries merged into the CLI-wide guide command.

views: Vec<HumanViewDef>

Human output views registered before command execution.

register: ModuleRegister

Registration function that returns the module’s runtime group.

Implementations

impl Module

pub fn new<F>(category: impl Into<String>, register: F) -> Self

where F: Fn(&mut ModuleContext<'_>) -> RuntimeGroupSpec + Send + Sync + 'static,

Creates a closure-based module.

pub fn from_command_module<M>(module: M) -> Self

where M: CommandModule,

Converts a trait-based module into the runtime module type.

pub fn with_guide(self, guide: GuideEntry) -> Self

Adds one guide entry.

pub fn with_guides(self, guides: impl IntoIterator<Item = GuideEntry>) -> Self

Adds several guide entries.

pub fn with_guides_from_markdown( self, files: impl IntoIterator<Item = (impl AsRef<Path>, impl AsRef<[u8]>)>, ) -> Self

Parses markdown guide entries from embedded (path, bytes) pairs.

pub fn with_view(self, view: HumanViewDef) -> Self

Adds one human output view.

Trait Implementations

impl Clone for Module

fn clone(&self) -> Module

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Module

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

Formats the value using the given formatter.