Struct Run 

pub struct Run {
    pub schema: String,
    pub origin: String,
    pub complete: bool,
    pub source: BTreeMap<String, String>,
    pub breakpoints: Vec<u32>,
    pub viewports: Vec<u32>,
    pub surfaces: Vec<Surface>,
    pub foreign: Vec<Foreign>,
    pub pages: usize,
    pub visits: usize,
    pub seconds: u64,
    pub findings: Vec<Finding>,
}

A whole audit run.

Fields

schema: String

The contract of this document.

origin: String

The origin the audit drove.

complete: bool

Whether every discovered page was visited, or the run was narrowed for iteration.

source: BTreeMap<String, String>

Where the pages and the widths came from.

breakpoints: Vec<u32>

The breakpoints the compiled stylesheet declared.

viewports: Vec<u32>

The widths the sweep visits.

surfaces: Vec<Surface>

Every surface the run measured, and what each contributed.

foreign: Vec<Foreign>

Every subtree the engine was told to skip, once per declaration.

pages: usize

How many pages were visited.

visits: usize

How many page-and-width visits that came to.

seconds: u64

How long the run took, in whole seconds.

findings: Vec<Finding>

Every finding, in the order the run produced them.

Implementations

impl Run

pub fn green(&self) -> bool

Did every page pass?

pub fn by_rule(&self) -> Vec<(String, usize)>

The findings per rule, most frequent first, then by rule name.

Derived rather than read from the document: a count and a list that can disagree is a report that will one day lie about its own evidence.

use majordomus_cli::web::report::ui::parse;
let run = parse(r#"{"schema":"ui-audit/v1","pages":1,"visits":1,"findings":[
    {"route":"/","width":320,"rule":"a","detail":"x"},
    {"route":"/","width":320,"rule":"a","detail":"y"},
    {"route":"/","width":320,"rule":"b","detail":"z"}]}"#).unwrap();
assert_eq!(run.by_rule(), vec![("a".to_string(), 2), ("b".to_string(), 1)]);

pub fn routes_of(&self, rule: &str) -> Vec<&str>

The pages a rule was found on, deduplicated and ordered.

Trait Implementations

impl Clone for Run

fn clone(&self) -> Run

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Run

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Run

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Run

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

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 Run