Struct Artifact 

pub struct Artifact {
    pub path: String,
    pub document: String,
    pub format: ArtifactFormat,
    pub schema: Option<String>,
    pub source: String,
    pub content: String,
}

One generated file: what it projects, how it is encoded, what contract its content satisfies, where it came from, and the whole file.

Fields

path: String

Repository-relative path.

document: String

The document it projects: registry, cli, openapi, capabilities, … Two artifacts sharing an id are the same document in two encodings.

format: ArtifactFormat

The encoding.

schema: Option<String>

The JSON Schema its content satisfies, by schema id, when it declares one.

source: String

One line: what it was derived from, as the header says it.

content: String

The whole file.

Implementations

impl Artifact

pub fn markdown( path: impl Into<String>, document: impl Into<String>, source: impl Into<String>, version: &str, body: &str, ) -> Artifact

A Markdown artifact: the banner, then the body. Nothing writes the banner itself.

pub fn text( path: impl Into<String>, document: impl Into<String>, source: impl Into<String>, version: &str, body: &str, ) -> Artifact

A text artifact another program reads line by line: the banner as # comments, then the lines.

pub fn json_extension( path: impl Into<String>, document: impl Into<String>, source: impl Into<String>, version: &str, value: Value, ) -> Artifact

A JSON artifact whose own specification fixes its member names — a JSON Schema, the OpenAPI document — so its provenance goes in x-majordomus- extensions rather than in members the specification does not define. Both forms are read back by violations; neither is more generated than the other.

pub fn comment_text( path: impl Into<String>, document: impl Into<String>, source: impl Into<String>, version: &str, body: &str, ) -> Artifact

A line-oriented text artifact whose banner takes the comment form its suffix allows: /* */ for a stylesheet or a script, <!-- --> for an SVG, # otherwise. A stylesheet cannot open with # and an image cannot open with a shell comment; violations asks for the same form by the same suffix.

use majordomus_cli::generate::Artifact;

let css = Artifact::comment_text("a/b.css", "doc", "the source", "0.1.0", "body { }\n");
assert!(css.content.starts_with("/* GENERATED FILE"), "{}", css.content);
assert!(css.content.ends_with("body { }\n"));

// the same body under a different suffix opens the way that suffix allows
let svg = Artifact::comment_text("a/b.svg", "doc", "the source", "0.1.0", "<svg/>\n");
assert!(svg.content.starts_with("<!-- GENERATED FILE"), "{}", svg.content);

pub fn verbatim( path: impl Into<String>, document: impl Into<String>, format: ArtifactFormat, schema: Option<String>, source: impl Into<String>, content: String, ) -> Artifact

An artifact whose content is taken as it stands: a projection another module renders whole and stamps itself (the provider bootstraps, the site dataset).

Trait Implementations

impl Clone for Artifact

fn clone(&self) -> Artifact

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Artifact

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

Formats the value using the given formatter.

impl Eq for Artifact

impl PartialEq for Artifact

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Artifact