Struct Settings

pub struct Settings {
    pub prefer: ConfigFormat,
    pub allow_json: bool,
    pub allow_json5: bool,
    pub allow_toml: bool,
}

Which formats are allowed and which to prefer

Fields

prefer: ConfigFormat

The preferred configuration format. This is always allowed implicitly.

allow_json: bool

Explicit permission to parse as JSON

allow_json5: bool

Explicit permission to parse as JSON5.

Implicitly allows JSON as it is a subset of JSON5.

allow_toml: bool

Explicit permission to parse as TOML

Implementations

impl Settings

pub const fn allow_all(prefer: ConfigFormat) -> Self

Creates a new settings instance that allows all formats but prefers the given one.

pub const fn prefer_json() -> Self

Allow all formats, but prefer JSON.

pub const fn prefer_json5() -> Self

Allow all formats, but prefer JSON5.

pub const fn prefer_toml() -> Self

Allow all formats, but prefer TOML.

pub const fn allow_only(prefer: ConfigFormat) -> Self

Creates a new settings instance that only allows the given preferred format.

pub const fn only_json() -> Self

Only allows parsing as JSON.

pub const fn only_json5() -> Self

Only allows parsing as JSON5 (and JSON).

pub const fn only_toml() -> Self

Only allow parsing as TOML.

pub fn is_allowed(&self, test_for: ConfigFormat) -> bool

Wheter the settings allow the parsing the given configuration format.

Trait Implementations

impl Clone for Settings

fn clone(&self) -> Settings

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Settings

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Settings

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Settings

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Settings