Enum About 

pub enum About {
    Off,
    Structure,
}

Whether the workspace generates about.md — a short prose page, specialized against this workspace’s own configuration, that tells a reader with no prior knowledge how to read this directory.

The gap it closes is narrow and specific. A prov workspace already explains its structure — the links are in the documents, visibly — but not its conventions: what the links mean, how they are spelled, which files are in the tree and which are not. Those live in the config, which is machine-facing and assumes the reader already knows what its keys mean. So a person who opens the directory with no prior knowledge cannot today learn to read it from the directory; they must obtain docs/spec.md, which is a dependency on an institution surviving — exactly the dependency the project refuses everywhere else.

The page is not a vendored copy of the spec. It is the spec specialized against this configuration: every rule resolved to a concrete fact, every branch this workspace does not take deleted. Where the spec says “the block is fenced by ---, ;;;, or ```fig,” the generated page says “every file here opens with a --- line.” Nothing is lost operationally, and the sentence is about this directory rather than about prov.

Default on, unlike History: it costs a few hundred bytes and one file, and a workspace that explains itself to a stranger by default is the whole thesis — making it opt-in concedes it.

Variants

Off

No page is generated and the root declares no about pointer (off).

Structure

Generate the page describing the workspace’s structure (structure, the default): the root and the spine; how a file is fenced; how a reference is written and what else is read; the relation vocabulary; what is machinery and not in the tree; the id, checksum and deletion conventions.

Implementations

impl About

pub fn generates(self) -> bool

Whether a page is generated at all.

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

Parse the about config spelling; unknown → None.

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

The about config spelling.

Trait Implementations

impl Clone for About

fn clone(&self) -> About

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for About

impl Debug for About

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

Formats the value using the given formatter.

impl Default for About

fn default() -> About

Returns the “default value” for a type.

impl Eq for About

impl PartialEq for About

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for About