Skip to main content

Reference

Struct Reference 

Source
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 str

Everything 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> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more