pub struct ConfigLoader<Profile> { /* private fields */ }Expand description
A utility to load hierarchical configuration in a Pavex application.
Check out ConfigLoader::load for more information.
§Example
use pavex::config::{ConfigLoader, ConfigProfile};
#[derive(ConfigProfile, Debug, Clone, Copy, PartialEq, Eq)]
pub enum Profile {
#[px(profile = "dev")]
Development,
#[px(profile = "prod")]
Production,
}
#[derive(Debug, Clone, serde::Deserialize)]
pub struct Config {
database_url: String,
// Other fields...
}
let config: Config = ConfigLoader::<Profile>::new().load()?;Implementations§
Source§impl<Profile> ConfigLoader<Profile>where
Profile: ConfigProfile,
impl<Profile> ConfigLoader<Profile>where
Profile: ConfigProfile,
Sourcepub fn new() -> Self
pub fn new() -> Self
Initialize a new ConfigLoader instance.
Sourcepub fn profile(self, profile: Profile) -> Self
pub fn profile(self, profile: Profile) -> Self
Specify the application profile manually, rather than loading it
from the PX_PROFILE environment variable.
Sourcepub fn configuration_dir<Dir>(self, dir: Dir) -> Self
pub fn configuration_dir<Dir>(self, dir: Dir) -> Self
Specify the path to the directory where configuration files are stored.
§Relative paths
If you provide a relative path, it will be resolved relative to the current working directory. If it’s not found there, Pavex will look for it in the parent directory, up until the root directory, stopping at the first hit.
§Absolute paths
If you provide an absolute path, it will be used as is.
§Default value
By default, Pavex looks for configuration files under configuration/.
Sourcepub fn load<Config>(self) -> Result<Config, ConfigLoadError>where
Config: DeserializeOwned,
pub fn load<Config>(self) -> Result<Config, ConfigLoadError>where
Config: DeserializeOwned,
Load the configuration for the application by merging together three sources:
- Environment variables (
PX_*) - Profile-specific configuration file (
{configuration_dir}/{profile}.yml) - Base configuration file (
{configuration_dir}/base.yml)
The list above is ordered by precedence: environment variables take precedence over profile-specific configuration files, which in turn take precedence over the base configuration file.
§Guide
Check out the guide for an overview of Pavex’s configuration hierarchy, as well as a detailed explanation of the naming convention used for environment variables.
Trait Implementations§
Source§impl<Profile: Clone> Clone for ConfigLoader<Profile>
impl<Profile: Clone> Clone for ConfigLoader<Profile>
Source§fn clone(&self) -> ConfigLoader<Profile>
fn clone(&self) -> ConfigLoader<Profile>
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreAuto Trait Implementations§
impl<Profile> Freeze for ConfigLoader<Profile>where
Profile: Freeze,
impl<Profile> RefUnwindSafe for ConfigLoader<Profile>where
Profile: RefUnwindSafe,
impl<Profile> Send for ConfigLoader<Profile>where
Profile: Send,
impl<Profile> Sync for ConfigLoader<Profile>where
Profile: Sync,
impl<Profile> Unpin for ConfigLoader<Profile>where
Profile: Unpin,
impl<Profile> UnwindSafe for ConfigLoader<Profile>where
Profile: UnwindSafe,
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
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
§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();§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
§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();§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
§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();§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
§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();§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>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.§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);