Skip to main content

ConfigLoader

Struct ConfigLoader 

Source
pub struct ConfigLoader;
Expand description

Configuration loader with format detection and parsing.

Implementations§

Source§

impl ConfigLoader

Source

pub fn load<T: DeserializeOwned>(path: impl AsRef<Path>) -> Result<T>

Load configuration from a file with automatic format detection.

Format is determined by file extension:

  • .yaml, .yml -> YAML
  • .json -> JSON
  • .toml -> TOML
§Errors

Returns error if:

  • File cannot be read
  • Format cannot be determined from extension
  • Content fails to parse
Source

pub fn load_with_format<T: DeserializeOwned>( path: impl AsRef<Path>, format: ConfigFormat, ) -> Result<T>

Load configuration from a file with explicit format.

Source

pub fn load_from_reader<T: DeserializeOwned, R: Read>( reader: &mut R, format: ConfigFormat, ) -> Result<T>

Load configuration from a reader with explicit format.

Source

pub fn parse<T: DeserializeOwned>( content: &str, format: ConfigFormat, ) -> Result<T>

Parse configuration from a string with specified format.

Source

pub fn serialize<T: Serialize>( config: &T, format: ConfigFormat, ) -> Result<String>

Serialize configuration to a string.

Source

pub fn save<T: Serialize>(config: &T, path: impl AsRef<Path>) -> Result<()>

Save configuration to a file with automatic format detection.

Source

pub fn save_with_format<T: Serialize>( config: &T, path: impl AsRef<Path>, format: ConfigFormat, ) -> Result<()>

Save configuration to a file with explicit format.

Source

pub fn load_first<T: DeserializeOwned>( paths: &[impl AsRef<Path>], ) -> Result<(T, PathBuf)>

Try to load configuration from multiple paths, returning the first success.

Useful for loading from default locations:

let config: EngineConfig = ConfigLoader::load_first(&[
    "config.yaml",
    "config.json",
    "/etc/trap-sim/config.yaml",
])?;
Source

pub fn is_supported(path: impl AsRef<Path>) -> bool

Check if a file format is supported.

Auto Trait Implementations§

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

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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