Struct CheckResult

Source

pub struct CheckResult {
    pub name: String,
    pub verdict: Verdict,
    pub severity: Option<Severity>,
    pub detail: Option<String>,
    pub at: DateTime<Utc>,
    pub duration_ms: Option<u64>,
    pub tags: Vec<String>,
    pub evidence: Vec<Evidence>,
}

Expand description

Result of a single check.

§Example

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

let c = CheckResult::fail("unit::math", Severity::Error)
    .with_detail("expected 42, got 41")
    .with_duration_ms(7);
assert_eq!(c.verdict, Verdict::Fail);

Fields§

§name: String

Stable identifier for the check (e.g. compile, test::round_trip).

§verdict: Verdict

Outcome of the check.

§severity: Option<Severity>

Severity when the verdict is Fail or Warn. None for Pass and Skip.

§detail: Option<String>

Human-readable detail. Optional.

§at: DateTime<Utc>

Time the check ran. UTC.

§duration_ms: Option<u64>

Duration of the check, in milliseconds. Optional.

§tags: Vec<String>

Free-form tags for filtering (e.g. "slow", "flaky", "bench").

Defaults to empty. v0.1.0 reports deserialize cleanly with no tags.

§evidence: Vec<Evidence>

Structured evidence backing this check.

Defaults to empty. v0.1.0 reports deserialize cleanly with no evidence.

Implementations§

Source §

impl CheckResult

Source

pub fn pass(name: impl Into<String>) -> Self

Build a passing check result with the given name.

§Example

use dev_report::{CheckResult, Verdict};

let c = CheckResult::pass("compile");
assert_eq!(c.verdict, Verdict::Pass);
assert!(c.severity.is_none());

Source

pub fn fail(name: impl Into<String>, severity: Severity) -> Self

Build a failing check result with the given name and severity.

§Example

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

let c = CheckResult::fail("test::round_trip", Severity::Error);
assert_eq!(c.verdict, Verdict::Fail);
assert_eq!(c.severity, Some(Severity::Error));

Source

pub fn warn(name: impl Into<String>, severity: Severity) -> Self

Build a warning check result with the given name and severity.

§Example

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

let c = CheckResult::warn("flaky", Severity::Warning);
assert_eq!(c.verdict, Verdict::Warn);

Source

pub fn skip(name: impl Into<String>) -> Self

Build a skipped check result with the given name.

§Example

use dev_report::{CheckResult, Verdict};

let c = CheckResult::skip("not_applicable");
assert_eq!(c.verdict, Verdict::Skip);

Source

pub fn with_detail(self, detail: impl Into<String>) -> Self

Attach a human-readable detail to this check result.

§Example

use dev_report::CheckResult;

let c = CheckResult::pass("a").with_detail("ran in single thread");
assert_eq!(c.detail.as_deref(), Some("ran in single thread"));

Source

pub fn with_duration_ms(self, ms: u64) -> Self

Attach a duration measurement (milliseconds) to this check result.

§Example

use dev_report::CheckResult;

let c = CheckResult::pass("a").with_duration_ms(42);
assert_eq!(c.duration_ms, Some(42));

Source

pub fn with_severity(self, severity: Severity) -> Self

Override the severity of this check result.

Useful when escalating or de-escalating a check after construction (e.g. promote a Warn+Warning to Warn+Error based on a config flag).

§Example

use dev_report::{CheckResult, Severity};

let c = CheckResult::warn("flaky", Severity::Warning)
    .with_severity(Severity::Error);
assert_eq!(c.severity, Some(Severity::Error));

Source

pub fn with_tag(self, tag: impl Into<String>) -> Self

Attach a single tag to this check result.

§Example

use dev_report::CheckResult;

let c = CheckResult::pass("compile").with_tag("slow");
assert!(c.has_tag("slow"));

Source

pub fn with_tags<I, S>(self, tags: I) -> Self
where I: IntoIterator<Item = S>, S: Into<String>,

Attach many tags at once from any iterable of strings.

§Example

use dev_report::CheckResult;

let c = CheckResult::pass("compile").with_tags(["slow", "flaky"]);
assert!(c.has_tag("flaky"));

Source

pub fn has_tag(&self, tag: &str) -> bool

Return true if this check has the given tag.

§Example

use dev_report::CheckResult;

let c = CheckResult::pass("compile").with_tag("slow");
assert!(c.has_tag("slow"));
assert!(!c.has_tag("flaky"));

Source

pub fn with_evidence(self, e: Evidence) -> Self

Attach a single piece of Evidence to this check result.

§Example

use dev_report::{CheckResult, Evidence};

let c = CheckResult::pass("bench")
    .with_evidence(Evidence::numeric("mean_ns", 1234.0));
assert_eq!(c.evidence.len(), 1);

Source

pub fn with_evidences(self, items: I) -> Self
where I: IntoIterator<Item = Evidence>,

Attach many Evidence items at once from any iterable.

§Example

use dev_report::{CheckResult, Evidence};

let c = CheckResult::pass("bench").with_evidences([
    Evidence::numeric("mean_ns", 1234.0),
    Evidence::numeric("baseline_ns", 1100.0),
]);
assert_eq!(c.evidence.len(), 2);