Struct DocRegistry 

pub struct DocRegistry { /* private fields */ }

holds every command doc and guide for the current program session.

Implementations

impl DocRegistry

pub fn new() -> Self

start fresh.

pub fn register_command<K: Into<String>>(&mut self, key: K, doc: CommandDoc)

attach metadata to a command path (dot-separated, "" for the main program).

pub fn register_guide<K, C>(&mut self, key: K, content: C)

where K: Into<String>, C: Into<String>,

add a free-form markdown guide that can be opened via guide <path>.

pub fn command(&self, key: &str) -> Option<&CommandDoc>

fetch docs for a command, if any.

pub fn guide(&self, key: &str) -> Option<&str>

fetch markdown for a guide, if any.

Trait Implementations

impl Default for DocRegistry

fn default() -> DocRegistry

Returns the “default value” for a type.