Struct QualityReport 

pub struct QualityReport {
    pub schema: String,
    pub target: String,
    pub public_api: PublicApiQuality,
    pub modules: ModuleQuality,
    pub operations: OperationParity,
    pub violations: Vec<Violation>,
}

One measurement of one crate, and everything found wrong in it.

Fields

schema: String

SCHEMA.

target: String

What was measured: the crate directory, repository-relative.

public_api: PublicApiQuality

The exported item surface.

modules: ModuleQuality

The exported module surface.

operations: OperationParity

The canonical operations against their transports.

violations: Vec<Violation>

Every finding, errors first, then by file and line.

Implementations

impl QualityReport

pub fn passes(&self) -> bool

Nothing wrong at any severity that blocks?

use majordomus_cli::quality::{QualityReport, Violation, ViolationCode};
let mut r = QualityReport::default();
assert!(r.passes());
r.violations.push(Violation::new(
    ViolationCode::RustModuleMissingDocs, "m", "src/m.rs", Some(1), "no header"));
assert!(!r.passes());

pub fn count(&self, severity: Severity) -> usize

How many findings of a severity.

pub fn exit_code(&self) -> u8

The process exit code: 0 clean, 10 contract unmet, which is the code every other unmet contract in this executable uses.

use majordomus_cli::quality::{QualityReport, Violation, ViolationCode};
let mut r = QualityReport::default();
assert_eq!(r.exit_code(), 0);
r.violations.push(Violation::new(
    ViolationCode::OperationCliUnclassified, "majordomus x", "", None, "unclassified"));
assert_eq!(r.exit_code(), 10);

pub fn of(&self, code: ViolationCode) -> Vec<&Violation>

Findings of one code, in report order.

use majordomus_cli::quality::{QualityReport, Violation, ViolationCode};
let mut r = QualityReport::default();
r.violations.push(Violation::new(
    ViolationCode::RustModuleMissingExample, "m", "src/m.rs", Some(1), "none"));
assert_eq!(r.of(ViolationCode::RustModuleMissingExample).len(), 1);
assert!(r.of(ViolationCode::RustModuleMissingDocs).is_empty());

pub fn sort(&mut self)

Sort the findings the way every rendering shows them: errors first, then by file, then by line, then by code, so that two runs over one tree print the same report.

Trait Implementations

impl Clone for QualityReport

fn clone(&self) -> QualityReport

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for QualityReport

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

Formats the value using the given formatter.

impl Default for QualityReport

fn default() -> QualityReport

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for QualityReport

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for QualityReport

impl JsonSchema for QualityReport

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 QualityReport

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

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 QualityReport