Struct Document 

pub struct Document {
    pub id: String,
    pub dir: String,
    pub schema: Option<String>,
    pub source: String,
    pub style: HeaderStyle,
    pub value: Value,
}

One generated document: a value with an identity, a schema and a provenance line, projected into every encoding this repository commits it in. The encodings cannot disagree because there is one value; adding an encoding is a line in Document::artifacts, never a second renderer.

Fields

id: String

The document id, which is also the file stem: registry, cli, openapi.

dir: String

The directory the encodings are written into, repository-relative.

schema: Option<String>

The JSON Schema the value satisfies, when it declares one.

source: String

One line: what it was derived from.

style: HeaderStyle

Where the provenance goes.

value: Value

The value, before provenance is added.

Implementations

impl Document

pub fn new( id: impl Into<String>, schema: impl Into<String>, source: impl Into<String>, value: Value, ) -> Document

A document of this repository’s own, provenance as members.

pub fn stamped(&self, version: &str) -> Value

The value with its provenance in it: what both encodings serialise.

pub fn artifacts(&self, version: &str) -> Vec<Artifact>

The document in every encoding it is committed in: JSON, then YAML.

Trait Implementations

impl Clone for Document

fn clone(&self) -> Document

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Document

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

Formats the value using the given formatter.