Enum Format 

#[non_exhaustive]
pub enum Format {
    Json,
    Jsonc,
    Json5,
    Yaml,
    Toml,
    Zon,
    Fig,
    Ini,
    Dotenv,
    Properties,
    Plist,
    Nestedtext,
    Runtime(RuntimeFormat),
}

A config format. Every variant parses, edits, and serializes.

Every variant is always present in the enum, but each format is gated by a crate feature of the same name (json, yaml, toml, zon, fig). Every format the core registers. json, yaml, toml, fig, ini, dotenv, properties and nestedtext are on by default; zon and plist are opt-in features. Disabling a feature compiles that format out of the bundled native library, so selecting it then fails with Error::UnsupportedFormat at runtime. Json/Jsonc/Json5 share one core behind the json feature.

#[non_exhaustive]: the core gains formats over time, so a match needs a _ arm. Constructing a variant is unaffected.

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.

Json

Jsonc

Json5

Yaml

Toml

Zon

Fig

The native fig authoring dialect (see src/languages/fig/DESIGN.md in the core repo) — a memorable, typeable surface over the same AST.

Ini

INI ([section] + key = value). Untyped-string scalars: port = 8080 reads back as the string "8080". A root mapping and one level of [section] nesting only.

Dotenv

dotenv / .env (flat KEY=value). A flat string map: no nesting, untyped scalars.

Properties

Java .properties (flat key=value). Same flat, untyped limits as Format::Dotenv.

Plist

Apple XML property list. Typed and nested (dict/array/string/integer/ real/bool, with date/data on the extended scalar). Opt-in: the plist feature.

Nestedtext

NestedText (https://nestedtext.org). Nested (dict/list) but deliberately untyped — every leaf is a string.

Runtime(RuntimeFormat)

A language registered at runtime through language::register — the value that call returns, a peer of every variant above at every entry point that takes a Format. Its integer is assigned per process: persist the name and resolve it with Format::by_name.

Implementations

impl Format

pub fn by_name(name: &str) -> Option<Format>

The format named name: a compiled format’s registry name ("json5", "yaml", …) or a language registered at runtime. None when nothing answers to it in this process.

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<(), Error>

Formats the value using the given formatter.

impl Eq for Format

impl PartialEq for Format

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Format