Struct Documentation 

pub struct Documentation {
    pub projection: String,
    pub route: Option<String>,
    pub url: Option<String>,
    pub reason: Option<String>,
    pub declared_in: String,
}

The public documentation page of one entity, as its kind’s publication decision derives it. Every surface that shows an entity carries this value and renders it; none of them derives a public address of its own.

use majordomus_cli::entity::Documentation;

let d = Documentation {
    projection: "entity".into(),
    route: Some("/adrs/adr-0056/".into()),
    url: Some("https://majordomus.dev/adrs/adr-0056/".into()),
    reason: None,
    declared_in: "site/data/publication.toml".into(),
};
let wire = serde_json::to_value(&d).unwrap();
assert_eq!(wire["url"], serde_json::json!("https://majordomus.dev/adrs/adr-0056/"));
// a field that does not apply is absent, not an empty string
assert!(wire.get("reason").is_none());

Fields

projection: String

The kind’s projection: entity, section or none.

route: Option<String>

The public route of the page, site-relative: the entity’s own page for an entity kind, the kind’s section for a section kind, absent for none.

url: Option<String>

The route under the site’s base_url, when the site configuration names one.

reason: Option<String>

Why the kind is not published, for none.

declared_in: String

The file the decision is read from.

Trait Implementations

impl Clone for Documentation

fn clone(&self) -> Documentation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Documentation

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Documentation

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Documentation

impl JsonSchema for Documentation

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for Documentation

fn eq(&self, other: &Documentation) -> 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 Serialize for Documentation

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Documentation