Struct Surface 

pub struct Surface {
    pub id: String,
    pub mount: String,
    pub kind: String,
    pub routes: usize,
    pub families: usize,
    pub sampled: usize,
    pub truncated: bool,
}

One surface the audit measured, and what it contributed.

A built surface is a directory, and every page of it is visited. A surface the executable renders has no directory: its routes are crawled out of its own anchors and a sample of each family is visited, so the number of routes it has is reported beside the number that was sampled. A sample rendered as a total would be a report overstating its own coverage, and the Cockpit’s thousands of routes are why that distinction belongs on the page rather than in somebody’s head.

use majordomus_cli::web::report::ui::{parse, Surface};
let run = parse(r#"{"schema":"ui-audit/v1","pages":108,"visits":478,"findings":[],
    "surfaces":[{"id":"cockpit","mount":"/cockpit","kind":"native-route",
                 "routes":2660,"families":14,"sampled":108}]}"#).unwrap();
let surface: &Surface = &run.surfaces[0];
assert_eq!((surface.routes, surface.sampled), (2660, 108));
assert!(!surface.truncated, "a crawl that hit its budget reports a floor, not a total");

Fields

id: String

The surface’s id in the topology.

mount: String

Where the executable serves it.

kind: String

static-directory or native-route.

routes: usize

How many routes the surface has, when they were crawled rather than read from disk.

families: usize

How many families those routes fell into.

sampled: usize

How many of them the audit visited.

truncated: bool

Whether the crawl hit its budget, so the route count is a floor rather than a total.

Trait Implementations

impl Clone for Surface

fn clone(&self) -> Surface

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Surface

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Surface

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Surface

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

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 Surface