Enum FileFormat

#[non_exhaustive]
pub enum FileFormat {
    Toml,
    Ron,
    Json,
    Yaml,
}

The format of a configuration file.

Currently, conrig supports toml, json, yaml and ron as possible languages.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Toml

Available on crate feature toml only.

The toml language. Supported by toml.

Ron

Available on crate feature ron only.

The ron language. Supported by ron.

Json

Available on crate feature json only.

The json language. Supported by serde_json.

Yaml

Available on crate feature yaml only.

The yaml language. Supported by serde_yaml.

Implementations

impl FileFormat

pub const DEFAULT_FILE_FORMAT: FileFormat = FileFormat::Toml

Default file format.

Priority order:

1. Toml;
2. Json;
3. Yaml;
4. Ron;

pub const fn extension(&self) -> &'static str

Get the file extension of the given language.

Note that for the YAML language, this will return only yaml.

pub fn read_str<'de, T: Deserialize<'de>>( &self, input: &'de str, ) -> Result<T, LangError>

Deserialize a value from a given &str.

pub fn write<T: Serialize>( &self, input: &T, writer: &mut impl Write, ) -> Result<(), ConrigError>

Serialize a value and writes it to a writer.

Note: Toml and ron does not support directly writing into an io buffer, so they’re collected into a String and re-written into the buffer.

Trait Implementations

impl Clone for FileFormat

fn clone(&self) -> FileFormat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileFormat

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

Formats the value using the given formatter.

impl Default for FileFormat

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for FileFormat

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

impl Eq for FileFormat

impl StructuralPartialEq for FileFormat