pub struct Reference<'a> {
pub preamble: &'a str,
pub toml_path: &'a dyn Fn(&str) -> Option<String>,
pub credential_file_flags: &'a [&'a str],
pub tables: &'a [(&'a str, &'a [TableKey<'a>])],
}Expand description
How one application’s schema maps onto its reference document.
Fields§
§preamble: &'a strEverything above the first section: title, regeneration instructions, and conventions.
toml_path: &'a dyn Fn(&str) -> Option<String>The TOML path of a schema option ID, or None for an option that is
not a TOML setting (command-line-only flags, credential file flags).
credential_file_flags: &'a [&'a str]Credential file flags, as TOML-style paths (metrics.token_file).
conf refuses a flag on a secret field, so each credential with a
flag has a CLI-only <name>_file sibling; the reference shows that
flag on the credential’s own row.
tables: &'a [(&'a str, &'a [TableKey<'a>])]Whole-table settings conf treats as one opaque value, with the keys
each accepts, so the reference can still list them.
Auto Trait Implementations§
impl<'a> !RefUnwindSafe for Reference<'a>
impl<'a> !Send for Reference<'a>
impl<'a> !Sync for Reference<'a>
impl<'a> !UnwindSafe for Reference<'a>
impl<'a> Freeze for Reference<'a>
impl<'a> Unpin for Reference<'a>
impl<'a> UnsafeUnpin for Reference<'a>
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