Struct File

pub struct File<T, F> { /* private fields */ }

A configuration source backed up by a file.

It supports optional automatic file format discovery.

Implementations

impl<F> File<FileSourceString, F>

where F: FileStoredFormat + 'static,

pub fn from_str(s: &str, format: F) -> Self

impl<F> File<FileSourceFile, F>

where F: FileStoredFormat + 'static,

pub fn new(name: &str, format: F) -> Self

impl File<FileSourceFile, FileFormat>

pub fn with_name(name: &str) -> Self

Given the basename of a file, will attempt to locate a file by setting its extension to a registered format.

impl<T, F> File<T, F>

where F: FileStoredFormat + 'static, T: FileSource<F>,

pub fn format(self, format: F) -> Self

pub fn required(self, required: bool) -> Self

Set required to false to make a file optional when building the config.

Trait Implementations

impl<T: Clone, F: Clone> Clone for File<T, F>

fn clone(&self) -> File<T, F>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug, F: Debug> Debug for File<T, F>

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

Formats the value using the given formatter.

impl<'a> From<&'a Path> for File<FileSourceFile, FileFormat>

fn from(path: &'a Path) -> Self

Converts to this type from the input type.

impl From<PathBuf> for File<FileSourceFile, FileFormat>

fn from(path: PathBuf) -> Self

Converts to this type from the input type.

impl<T, F> Source for File<T, F>

where F: FileStoredFormat + Debug + Clone + Send + Sync + 'static, T: Sync + Send + FileSource<F> + 'static,

fn clone_into_box(&self) -> Box<dyn Source + Send + Sync>

fn collect(&self) -> Result<Map<String, Value>, ConfigError>

Collect all configuration properties available from this source and return a Map.

fn collect_to(&self, cache: &mut Value) -> Result<(), ConfigError>

Collects all configuration properties to a provided cache.