pub struct SettingsLoader<T> { /* private fields */ }Expand description
Loads and validates a typed configuration from layered sources.
Build it with the source methods, then call SettingsLoader::load. Each
source overrides the ones before it; see the module documentation for the full
precedence order.
Implementations§
Source§impl<T> SettingsLoader<T>
impl<T> SettingsLoader<T>
Sourcepub fn env_file(self, path: impl Into<PathBuf>) -> Self
pub fn env_file(self, path: impl Into<PathBuf>) -> Self
Loads variables from this .env file before reading the environment.
Existing environment variables are not overwritten.
Sourcepub fn prefix(self, prefix: impl Into<String>) -> Self
pub fn prefix(self, prefix: impl Into<String>) -> Self
Reads environment variables that start with prefix followed by _.
Nested fields use __ between levels (for example APP_SERVER__PORT).
Sourcepub fn config_file(self, path: impl Into<String>) -> Self
pub fn config_file(self, path: impl Into<String>) -> Self
Reads a base configuration file (TOML). A missing file is ignored.
Sourcepub fn file(self, path: impl Into<String>) -> Self
pub fn file(self, path: impl Into<String>) -> Self
Appends an environment-specific file (TOML). The {env} token in the path
is replaced with the resolved environment name. A missing file is ignored.
Sourcepub fn secrets_dir(self, dir: impl Into<PathBuf>) -> Self
pub fn secrets_dir(self, dir: impl Into<PathBuf>) -> Self
Reads one secret per file from a directory: the file name is the key (with
__ marking nesting) and the trimmed contents are the value.
Sourcepub fn override_value(self, key: impl AsRef<str>, value: impl Serialize) -> Self
pub fn override_value(self, key: impl AsRef<str>, value: impl Serialize) -> Self
Sets the highest-priority override for a key, overriding every source.
The key uses . between nesting levels (for example server.port).
Source§impl<T: DeserializeOwned + Validate<Context = ()>> SettingsLoader<T>
impl<T: DeserializeOwned + Validate<Context = ()>> SettingsLoader<T>
Sourcepub fn load(self) -> Result<T>
pub fn load(self) -> Result<T>
Merges every source, deserializes into T, and validates it.
Returns an error with code CONFIG_LOAD_FAILED when a source cannot be
parsed into T, or CONFIG_VALIDATION_ERROR (with field details) when the
value fails validation. Used at startup, either aborts before the app runs.
Trait Implementations§
Auto Trait Implementations§
impl<T> Freeze for SettingsLoader<T>
impl<T> RefUnwindSafe for SettingsLoader<T>
impl<T> Send for SettingsLoader<T>
impl<T> Sync for SettingsLoader<T>
impl<T> Unpin for SettingsLoader<T>
impl<T> UnsafeUnpin for SettingsLoader<T>
impl<T> UnwindSafe for SettingsLoader<T>
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
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);