Struct ReferencePage 

pub struct ReferencePage {
    pub surface: &'static str,
    pub module: String,
    pub path: String,
}

A page of the crate’s reference: the web surface that publishes it and the page within it, as the rustdoc check derives it from the crate’s own inventory.

The mount is deliberately not here. Whether the reference is composed into a build, and at which mount, is the build’s fact — scripts/site-build records every surface it composed in data/build.json — so a page links this one only when the build that renders it carries the surface, and at the mount it was composed at.

use majordomus_cli::site::ReferencePage;
use majordomus_cli::web::discover::RUSTDOC;
let page = ReferencePage {
    surface: RUSTDOC,
    module: "majordomus_cli::capability::builtin::quality".into(),
    path: "majordomus_cli/capability/builtin/quality/index.html".into(),
};
let v = serde_json::to_value(&page).unwrap();
assert_eq!(v["surface"], "rustdoc");
// relative to the surface: the mount is the build's, joined by the page that links it
assert!(!v["path"].as_str().unwrap().starts_with('/'));

Fields

surface: &'static str

The web surface the page is published under: crate::web::discover::RUSTDOC.

module: String

The Rust module’s crate path: majordomus_cli::capability::builtin::quality.

path: String

The page, relative to the surface’s root: majordomus_cli/capability/builtin/quality/index.html.

Trait Implementations

impl Clone for ReferencePage

fn clone(&self) -> ReferencePage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReferencePage

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

Formats the value using the given formatter.

impl Serialize for ReferencePage

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

where __S: Serializer,

Serialize this value into the given Serde serializer.