Struct ConfigFile 

pub struct ConfigFile {
    pub path: PathBuf,
    pub tier: ConfigTier,
    pub format: Format,
    pub content: Option<String>,
}

👎Deprecated since 2.0.1: use cfgmatic-source crate instead, which provides a unified configuration source API

A discovered configuration file.

Fields

path: PathBuf

👎Deprecated since 2.0.1: use cfgmatic-source crate instead, which provides a unified configuration source API

Full path to the file.

tier: ConfigTier

👎Deprecated since 2.0.1: use cfgmatic-source crate instead, which provides a unified configuration source API

Configuration tier (determines priority).

format: Format

👎Deprecated since 2.0.1: use cfgmatic-source crate instead, which provides a unified configuration source API

File format.

content: Option<String>

👎Deprecated since 2.0.1: use cfgmatic-source crate instead, which provides a unified configuration source API

Cached content (loaded on demand).

Implementations

impl ConfigFile

pub fn name(&self) -> Option<&str>

👎Deprecated since 2.0.1: use cfgmatic-source crate instead, which provides a unified configuration source API

Get the file name.

pub fn read(&mut self) -> Result<&str>

👎Deprecated since 2.0.1: use cfgmatic-source crate instead, which provides a unified configuration source API

Read the file content.

Errors

Returns an error if the file cannot be read.

Panics

Panics if the content was not set after reading (this should never happen in practice).

pub fn parse<T: DeserializeOwned>(&mut self) -> Result<T>

👎Deprecated since 2.0.1: use cfgmatic-source crate instead, which provides a unified configuration source API

Parse the file into a type T.

Errors

Returns an error if the file cannot be read or parsed.

pub fn parse_uncached<T: DeserializeOwned>(&self) -> Result<T>

👎Deprecated since 2.0.1: use cfgmatic-source crate instead, which provides a unified configuration source API

Parse without caching content.

Errors

Returns an error if the file cannot be read or parsed.

pub fn exists(&self) -> bool

👎Deprecated since 2.0.1: use cfgmatic-source crate instead, which provides a unified configuration source API

Check if the file exists.

pub fn modified(&self) -> Result<SystemTime>

👎Deprecated since 2.0.1: use cfgmatic-source crate instead, which provides a unified configuration source API

Get the file modification time.

Errors

Returns an error if file metadata cannot be retrieved.

Trait Implementations

impl Clone for ConfigFile

fn clone(&self) -> ConfigFile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConfigFile

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

Formats the value using the given formatter.

impl Display for ConfigFile

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

Formats the value using the given formatter.

impl Ord for ConfigFile

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ConfigFile

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for ConfigFile

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for ConfigFile