Skip to main content

OptionBuilder

Struct OptionBuilder 

Source
pub struct OptionBuilder<T: OptionType> { /* private fields */ }
Expand description

Fluent constructor for Option<T>. See Option::builder.

Implementations§

Source§

impl<T: OptionType> OptionBuilder<T>

Source

pub fn aliases(self, aliases: &'static [&'static str]) -> Self

Extra names that resolve to this option (ts for tabstop). Replaces any aliases set earlier. Each must be unique across the registry, or registration fails with crate::ConfigError::DuplicateName.

Source

pub fn validate(self, f: ValidateFn<T>) -> Self

Install the post-parse validator run on every write (see ValidateFn). Replaces any earlier one. The default passed to Option::builder is NOT validated.

Source

pub fn build(self) -> Option<T>

Finish: the Option<T> holding the default as its current value, ready for crate::ConfigRegistry::register.

Auto Trait Implementations§

§

impl<T> Freeze for OptionBuilder<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for OptionBuilder<T>
where T: RefUnwindSafe,

§

impl<T> Send for OptionBuilder<T>

§

impl<T> Sync for OptionBuilder<T>

§

impl<T> Unpin for OptionBuilder<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for OptionBuilder<T>
where T: UnsafeUnpin,

§

impl<T> UnwindSafe for OptionBuilder<T>
where T: UnwindSafe,

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.

§

impl<T> Instrument for T

§

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

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

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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
§

impl<T> WithSubscriber for T

§

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
§

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

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