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_config_example(self, set: bool) -> String

Renders config.example.toml: every supported key, with its default, its type and one line about what it does.

Generated rather than written, because a hand-kept example is another copy of the catalogue that ages without anyone noticing — which is exactly what happened to the four README samples this replaces. A test compares the committed file with this output, so the two cannot drift.

Every line is commented out. An example that sets forty keys explicitly freezes today’s defaults into the config of everyone who copies it: a later release improves flat_to_hnsw and they never see it. Uncomment the two or three you actually mean to change.

set renders the same file with every key active, which is what the test parses through the real loader — an example nothing can parse is worth less than no example.

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.