Scanner

Struct Scanner 

Source
pub struct Scanner;
Expand description

A small facade for finding the ConfigFiles relevant for the current binary crate.

Implementations§

Source§

impl Scanner

Source

pub fn find_config_files(dir_name: Option<&str>) -> Vec<ConfigFile>

Discovers and returns all ConfigFiles relevant to the current binary crate and the active [AppProfile].

The returned vector is ordered for precedence: later files in the list should override earlier files when keys overlap.

§Search Location

Scans for configuration files within the resolved configuration directory.

§Supported Formats

The following file formats are recognized:

  • TOML (.toml)
  • YAML (.yml, .yaml)
§File Types
  • Generic config files: Apply to all profiles.
    • Pattern: config/{any_name}.{ext}
  • Profile-specific config files: Apply only if the file’s profile matches the active [AppProfile].
    • Patterns:
      • config/{any_name}.{profile}.{ext}
      • config/{profile}/{any_name}.{ext}
§Ordering
  • Generic files always precede profile-specific files.
  • Within each group (generic and profile-specific), files are ordered lexicographically by full path.
§Notes
  • File and directory names are matched case-insensitively.
§Returns

An ordered Vec<ConfigFile> containing all discovered configuration files.

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