Struct MultiReport 

pub struct MultiReport {
    pub schema_version: u32,
    pub subject: String,
    pub subject_version: String,
    pub started_at: DateTime<Utc>,
    pub finished_at: Option<DateTime<Utc>>,
    pub reports: Vec<Report>,
}

Aggregate of multiple Reports emitted in a single run.

Identity of a check is (producer, name). Two checks with the same name from different producers are kept separate.

Example

use dev_report::{CheckResult, MultiReport, Report, Severity, Verdict};

let mut bench = Report::new("crate", "0.1.0").with_producer("dev-bench");
bench.push(CheckResult::pass("hot_path"));

let mut chaos = Report::new("crate", "0.1.0").with_producer("dev-chaos");
chaos.push(CheckResult::fail("recover", Severity::Error));

let mut multi = MultiReport::new("crate", "0.1.0");
multi.push(bench);
multi.push(chaos);
multi.finish();

assert_eq!(multi.overall_verdict(), Verdict::Fail);
assert_eq!(multi.total_check_count(), 2);

Fields

schema_version: u32

Schema version. Tracks the same number as Report::schema_version.

subject: String

Crate or project being reported on.

subject_version: String

Version of the subject.

started_at: DateTime<Utc>

When aggregation started.

finished_at: Option<DateTime<Utc>>

When aggregation finished, if known.

reports: Vec<Report>

Constituent reports.

Implementations

impl MultiReport

pub fn new( subject: impl Into<String>, subject_version: impl Into<String>, ) -> Self

Begin a new aggregate for the given subject and version.

pub fn push(&mut self, r: Report)

Append a constituent report.

pub fn finish(&mut self)

Mark aggregation finished, stamping the finish time.

pub fn overall_verdict(&self) -> Verdict

Compute the overall verdict across every check in every report.

Follows the same precedence as Report::overall_verdict: Fail > Warn > Pass > Skip.

pub fn total_check_count(&self) -> usize

Total number of checks across all constituent reports.

pub fn iter_checks(&self) -> impl Iterator<Item = (Option<&str>, &CheckResult)>

Iterate over every check across every constituent report, paired with the producer that emitted it.

Producers without a producer field are emitted as None.

pub fn checks_with_tag<'a>( &'a self, tag: &'a str, ) -> impl Iterator<Item = (Option<&'a str>, &'a CheckResult)>

Iterate over checks carrying the given tag, paired with their producer.

Example

use dev_report::{CheckResult, MultiReport, Report};

let mut bench = Report::new("c", "0.1.0").with_producer("dev-bench");
bench.push(CheckResult::pass("hot").with_tag("slow"));
bench.push(CheckResult::pass("cold"));

let mut multi = MultiReport::new("c", "0.1.0");
multi.push(bench);

let slow: Vec<_> = multi.checks_with_tag("slow").collect();
assert_eq!(slow.len(), 1);
assert_eq!(slow[0].0, Some("dev-bench"));

pub fn to_json(&self) -> Result<String>

Serialize this multi-report to JSON.

pub fn from_json(s: &str) -> Result<Self>

Deserialize a multi-report from JSON.

Trait Implementations

impl Clone for MultiReport

fn clone(&self) -> MultiReport

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MultiReport

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MultiReport

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for MultiReport

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

where __S: Serializer,

Serialize this value into the given Serde serializer.