Enum ConfigFormat

pub enum ConfigFormat {
    JSON,
    JSON5,
    TOML,
    YAML,
}

Enum used to configure the Configs file format.

You can use it in a ConfigSetupOptions, inside Config::from_options

⚠️ Make sure to enable the feature flag for a format before using it!

Variants

JSON

JSON5

TOML

YAML

Implementations

impl ConfigFormat

pub fn from_extension(ext: &OsStr) -> Option<Self>

Mainly used to convert file extensions into ConfigFormats
Also chooses the correct extension for both JSON types based on the enabled feature. (ex: if JSON5 is enabled, it chooses it for the “json” file extension)
Returns Option::None if the string/extension doesn’t match any known format.

Example:

if cfg!(feature = "json") {
    assert_eq!(
        ConfigFormat::from_extension(OsStr::new("json")).unwrap(),
        ConfigFormat::JSON
    );
} else if cfg!(feature = "json5") {
    assert_eq!(
        ConfigFormat::from_extension(OsStr::new("json5")).unwrap(),
        ConfigFormat::JSON5
    );
}

Trait Implementations

impl Clone for ConfigFormat

fn clone(&self) -> ConfigFormat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConfigFormat

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

Formats the value using the given formatter.

impl Default for ConfigFormat

fn default() -> Self

Returns the “default value” for a type.

impl Display for ConfigFormat

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

Formats the value using the given formatter.

impl PartialEq for ConfigFormat

fn eq(&self, other: &ConfigFormat) -> 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 Copy for ConfigFormat

impl StructuralPartialEq for ConfigFormat