Struct SettingsHelp 

pub struct SettingsHelp { /* private fields */ }

Runtime access to the complete config.toml help catalogue.

Implementations

impl SettingsHelp

pub const fn docs(self) -> &'static [SettingDoc]

Every documented config.toml key.

pub const fn config_path_precedence(self) -> &'static [&'static str]

Config-file discovery order, from highest to lowest precedence.

pub fn unknown_in(self, table: &Table) -> Vec<SettingWarning>

Reports every section and key in table that no surface claims.

The catalogue is the authority rather than the parser’s own key lists, and it has to be: [maintenance].batch_size belongs to the CLI and [server].workers to the MCP server, so a check that only knew what the shared loader parses would warn about both on every run.

Allocation-free in the ordinary case — a clean config returns an empty Vec, which allocates nothing. Only a real mistake costs anything.

pub fn render_human(self) -> String

Render the catalogue for a terminal or a human-facing tool response.

Trait Implementations

impl Clone for SettingsHelp

fn clone(&self) -> SettingsHelp

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SettingsHelp

impl Debug for SettingsHelp

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

Formats the value using the given formatter.