Struct ModuleContext 

pub struct ModuleContext<'middleware> { /* private fields */ }

Context available while a module registers itself.

The context gives module code access to shared registries without exposing parser internals. This keeps module registration declarative and easy to copy for new teams.

Implementations

impl<'middleware> ModuleContext<'middleware>

pub fn middleware(&self) -> &Middleware

Returns a shared view of middleware while registering the module.

pub fn middleware_mut(&mut self) -> &mut Middleware

Returns mutable middleware for module-specific setup.

pub fn config(&self) -> &ConfigFile

Returns the per-application config file as loaded at startup.

Read a consumer-owned section with ConfigFile::section. This is the same startup snapshot surfaced via CommandContext::config; see its documentation for snapshot-semantics caveats.

pub fn schema_registry(&mut self) -> &mut SchemaRegistry

Returns the schema registry for direct registration.

pub fn register_schema<T: OutputSchema>( &mut self, command_path: impl Into<String>, )

Registers a compact framework schema for a command path.

pub fn register_json_schema<T: JsonSchema>( &mut self, command_path: impl Into<String>, )

Registers JSON Schema generated with schemars for a command path.

pub fn register_view(&mut self, view: HumanViewDef)

Registers a human output view and keeps it with the module.

pub fn add_guide(&mut self, guide: GuideEntry)

Adds one guide entry.

pub fn add_guides(&mut self, guides: impl IntoIterator<Item = GuideEntry>)

Adds several guide entries.

pub fn add_guides_from_markdown( &mut self, files: impl IntoIterator<Item = (impl AsRef<Path>, impl AsRef<[u8]>)>, )

Parses and adds markdown guides from embedded (path, bytes) pairs.

Trait Implementations

impl<'middleware> Debug for ModuleContext<'middleware>

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

Formats the value using the given formatter.