Struct FileSource 

pub struct FileSource { /* private fields */ }

File-based configuration source.

Loads configuration from files in various formats.

Example

use cfgmatic_source::FileSource;

let source = FileSource::builder()
    .path("config.toml")
    .path("config.local.toml")
    .required(false)
    .build()?;

let raw = source.load_raw()?;

Implementations

impl FileSource

pub fn new(path: impl Into<PathBuf>) -> Self

Create a new file source.

pub fn builder() -> FileSourceBuilder

Create a builder for file source.

Trait Implementations

impl Debug for FileSource

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Source for FileSource

fn kind(&self) -> SourceKind

Get the kind of this source.

fn metadata(&self) -> SourceMetadata

Get metadata about this source.

fn load_raw(&self) -> Result<RawContent>

Load raw content from this source.

fn detect_format(&self) -> Option<Format>

Detect the format of this source.

fn is_required(&self) -> bool

Check if this source is required.

fn validate(&self) -> Result<()>

Validate this source.

fn is_optional(&self) -> bool

Check if this source is optional.

fn display_name(&self) -> String

Get the display name for this source.