pub struct SettingsHelp { /* private fields */ }Expand description
Runtime access to the complete config.toml help catalogue.
Implementations§
Source§impl SettingsHelp
impl SettingsHelp
Sourcepub const fn docs(self) -> &'static [SettingDoc]
pub const fn docs(self) -> &'static [SettingDoc]
Every documented config.toml key.
Sourcepub const fn config_path_precedence(self) -> &'static [&'static str]
pub const fn config_path_precedence(self) -> &'static [&'static str]
Config-file discovery order, from highest to lowest precedence.
Sourcepub fn render_human(self) -> String
pub fn render_human(self) -> String
Render the catalogue for a terminal or a human-facing tool response.
Trait Implementations§
Source§impl Clone for SettingsHelp
impl Clone for SettingsHelp
Source§fn clone(&self) -> SettingsHelp
fn clone(&self) -> SettingsHelp
Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreimpl Copy for SettingsHelp
Auto Trait Implementations§
impl Freeze for SettingsHelp
impl RefUnwindSafe for SettingsHelp
impl Send for SettingsHelp
impl Sync for SettingsHelp
impl Unpin for SettingsHelp
impl UnsafeUnpin for SettingsHelp
impl UnwindSafe for SettingsHelp
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more