Enum ContentFormat 

pub enum ContentFormat {
    Markdown,
    Djot,
    Html,
}

Which body-prose grammar a document is written in. Maps to a twig twig::Format one-to-one; kept as prov’s own type so callers can name a format without depending on twig directly, e.g. for the content_format config knob.

Variants

Markdown

Djot

Html

Implementations

impl ContentFormat

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

Infer the content format from a path’s extension. None for anything unrecognized (including config extensions, which have no body).

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

The canonical file extension for this grammar (no leading dot) — what a freshly authored document’s filename gets when prov derives a name from a title (prov new "A Title"). The inverse of the primary from_extension spelling.

pub fn as_config_str(self) -> &'static str

The content_format config-document spelling for this grammar.

pub fn from_config_str(value: &str) -> Option<Self>

Parse a content_format config value. Unknown → None (keep default).

pub fn is_lossy_to(self, other: Self) -> bool

Whether transcoding between self and other loses authored structure badly enough to need an explicit --force.

HTML is the lossy endpoint, in both directions. Into HTML is a one-way trip: the result is a rendering, and the Markdown or Djot the author wrote — the #, the _emph_, the fence — is gone from the file, recoverable only by re-deriving a guess at it. Out of HTML is that trip run backwards, and everything HTML carries that a prose grammar has no spelling for (attributes, nested inline markup, whole elements) survives only as a raw-HTML escape, or not at all.

Markdown ↔ Djot is deliberately not gated: twig re-spells emphasis, headings and raw HTML into the target grammar and carries footnotes, tables, code fences and [[wikilinks]] through intact. The one wart is a reference-style link, which is inlined ([x][ref] → [x](notes/b.md)), leaving its now-unused [ref]: definition behind — untidy, but nothing a reader loses.

Trait Implementations

impl Clone for ContentFormat

fn clone(&self) -> ContentFormat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ContentFormat

impl Debug for ContentFormat

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

Formats the value using the given formatter.

impl Eq for ContentFormat

impl PartialEq for ContentFormat

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ContentFormat