Skip to main content

Report

Struct Report 

Source
pub struct Report { /* private fields */ }
Expand description

Everything a validation run produced.

Implementations§

Source§

impl Report

Source

pub fn new() -> Self

An empty report.

Source

pub fn push(&mut self, finding: Finding)

Records a finding, or marks the report truncated when its cap is full.

Source

pub fn mark_truncated(&mut self)

Records that the run stopped early because it hit its finding budget.

A report that silently stops at N findings claims the file has N problems. This flag is what keeps that claim honest.

Source

pub const fn is_truncated(&self) -> bool

Whether the run stopped before checking everything.

Source

pub fn findings(&self) -> &[Finding]

Every finding, in the order produced.

Callers wanting a stable order across runs should use Report::sorted: production order follows traversal, which is deterministic for a given model but not meaningful.

Source

pub fn summary(&self) -> Summary

How many findings of each severity.

Source

pub fn sorted(&self) -> Vec<&Finding>

Findings in a stable, explicitly defined order.

Sorted by severity, then rule id, then entity id, then slot. Two runs over the same file always produce byte-identical output, which is what makes a report diffable in CI.

Source

pub fn extend(&mut self, other: Self)

Merges another report into this one, preserving the truncation flag.

Source

pub fn is_conformant(&self) -> bool

Whether anything this validator checked was violated.

Trait Implementations§

Source§

impl Clone for Report

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Report

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Report

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for Report

Source§

impl PartialEq for Report

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.