Enum Framing 

pub enum Framing {
    Pragmas,
    WholeFile,
}

How a generator’s output relates to the file that holds it.

The pragma form of docs/design/11-documentation-plan.md §17.6 assumes the output is Markdown, because the pragmas are HTML comments. pystub (D27) broke that assumption: its three outputs under crates/atune_py/python/atune/ are Python stubs, and a Python stub has no HTML comment to hide a pragma in. This enum is the whole accommodation — one method on the trait with a default, so the seven Markdown generators are untouched.

Variants

Pragmas

The default. The output is spliced between <!-- Begin auto-generated {label} --> and <!-- End … -->, and every byte outside the pragmas is the author’s.

WholeFile

The generator owns the file entirely: --mode write writes it (creating it if absent) and --mode check compares every byte, trailing newline included. There is no framing to preserve — which is the point: framing-preservation exists so hand-written prose survives, and a file with no hand-written prose has nothing to survive. The generated file says so in its own first line, in its own comment syntax; that banner is this mode’s pragma.

Trait Implementations

impl Clone for Framing

fn clone(&self) -> Framing

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Framing

impl Debug for Framing

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

Formats the value using the given formatter.

impl Eq for Framing

impl PartialEq for Framing

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Framing