Enum Format 

pub enum Format {
    Json,
    Toml,
    Yaml,
}

A configuration file format.

Every variant exists regardless of which features are enabled; parsing one whose feature is off is a runtime ErrorKind::Backend. Code written through #[dynamic_config] cannot reach that error — the macro turns it into a compile error naming the missing feature.

Variants

Json

JSON, via the json feature.

Toml

TOML, via the toml feature.

Yaml

YAML, via the yaml feature.

Implementations

impl Format

pub fn from_path(path: &Path) -> Result<Self, Error>

The format a path’s extension names.

A .age suffix is looked through: secrets.json.age is JSON that happens to be encrypted, so the format is the one under the suffix.

Errors

If the name resolves to no supported format.

pub fn feature(self) -> &'static str

The cargo feature that enables this format.

pub fn from_extension(extension: &str) -> Option<Self>

Infers a format from a file extension, case-insensitively.

Returns None for an unknown or absent extension. The macro performs the same inference at compile time.

pub fn from_key(key: &str) -> Option<Self>

Infers a format from a store key’s extension: app/config.json is JSON.

What every remote store crate does with the key it was given, written once. Returns None when the key has no extension or an unknown one — the store’s with_format exists for exactly that case.

Trait Implementations

impl Clone for Format

fn clone(&self) -> Format

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Format

impl Debug for Format

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

Formats the value using the given formatter.

impl Eq for Format

impl Hash for Format

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Format

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Format