Struct config::File

pub struct File<T> where
    T: FileSource,  { /* fields omitted */ }

Methods

impl File<FileSourceString>

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

impl File<FileSourceFile>

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

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: FileSource> File<T>

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

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

Trait Implementations

impl<T: FileSource> Source for File<T> where
    T: 'static,
    T: Sync + Send, 

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

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

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

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

impl<T: Clone> Clone for File<T> where
    T: FileSource, 

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Performs the conversion.

impl From<PathBuf> for File<FileSourceFile>

fn from(path: PathBuf) -> Self

Performs the conversion.

impl<T: Debug> Debug for File<T> where
    T: FileSource, 

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

Formats the value using the given formatter.