Enum Format 

pub enum Format {
    Json,
    Toml,
    Yaml,
    Dotenv,
    Ini,
    TomlFrontmatter,
    YamlFrontmatter,
    Markdown,
}

A format this build can actually read.

The optional backends gate their variants, not just their bodies: in a build without toml there is no Format::Toml at all, so code naming a format it did not enable fails to compile instead of returning a runtime refusal from deep inside load. Detection still answers for those files — see Format::unavailable — because a file’s format is a fact about the file, not about this build.

Variants

Json

Toml

Yaml

Dotenv

Ini

TomlFrontmatter

A +++-fenced TOML frontmatter block; the Markdown body is frozen. Never auto-detected — selected only via --input-format toml-frontmatter.

YamlFrontmatter

A ----fenced YAML frontmatter block; the Markdown body is frozen. Never auto-detected — selected only via --input-format yaml-frontmatter.

Markdown

A CommonMark document read as a tree of heading sections (preamble, h1, h1.0.h2, …). Read-only, and never auto-detected — the same .md file is legitimately readable as frontmatter, and choosing between two valid readings is not something an extension can decide.

Implementations

impl Format

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

Stable human-readable label used in document results and diagnostics.

pub const fn is_read_only(self) -> bool

Whether this format can be written at all.

Markdown is the one reader-only format: its parsed value is a flattened view of prose, so re-rendering a document from it would discard everything the flattening dropped. Every mutating verb refuses up front rather than producing that file.

pub const fn array_rule(self) -> Option<ArrayRule<'static>>

This format’s own rule for resolving a non-numeric path segment against an array, or None when only a caller-declared keyed list can.

A format earns a rule by owning the shape of its own value. Markdown’s value is a tree afdata synthesized — every node carries text because this crate put it there — so h2.look can be answered from the format alone. JSON, TOML, YAML, dotenv, and INI hand back whatever the file said; nothing in deps.foo tells afdata which field of a deps element foo is supposed to match, and inventing one is the shape-guessing this crate exists to refuse. Those keep needing an explicit KeyedList.

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

Exact CLI token accepted by --input-format and emitted in result payloads. Unlike Self::name, this is stable machine data rather than a display label.

pub fn detect(path: &Path) -> Option<Self>

Detect format from file extension, when this build can read it.

pub fn unavailable(path: &Path) -> Option<&'static str>

The Cargo feature a path’s format needs, when this build lacks it.

detect answers None both for a file this crate has never heard of and for one it knows perfectly well but was not built to read. Only the second is worth a different message, and only this can tell them apart, so the caller reports the missing feature instead of calling a .toml file’s format unknown.

pub fn load(&self, content: &str) -> DocumentResult<Value>

Load a config file in the detected format.

pub fn save(&self, value: &Value) -> DocumentResult<String>

Save a config in the target format.

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 PartialEq for Format

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Format