#[non_exhaustive]pub struct ReportSide { /* private fields */ }Expand description
What a comparison reads from one report.
Built from a ProfileReport, or from a flat summary (the document
ProfileReport::summary_json writes, and the one Python’s to_dict()
and pre-0.12 save() produced). A flat summary never becomes a
ProfileReport, because it cannot acquire provenance it never recorded,
but it carries everything a comparison reads, and what it did not record
is read as unrecorded.
Implementations§
Source§impl ReportSide
impl ReportSide
Sourcepub fn from_report(report: &ProfileReport) -> Self
pub fn from_report(report: &ProfileReport) -> Self
Read a profiled or loaded report.
Sourcepub fn unlisted_components(&self) -> &[String]
pub fn unlisted_components(&self) -> &[String]
Components carrying signal that neither of the side’s recorded coverage lists names. Their coverage, and that of any score weighing them, is unrecorded. Empty for a flat summary written before 0.14, which records no exact list.
Sourcepub fn summary_quality_unlisted_components(quality: &str) -> Result<Vec<String>>
pub fn summary_quality_unlisted_components(quality: &str) -> Result<Vec<String>>
Self::unlisted_components for the quality object of a flat
summary alone, for a reader that has no whole summary to read, such
as findings over a loaded one. Fails when the object holds a field of
the wrong type.
Sourcepub fn from_summary_json(text: &str) -> Result<Self>
pub fn from_summary_json(text: &str) -> Result<Self>
Read a flat summary document.
A field an older release did not write reads as unrecorded: scan
coverage it does not state is coverage_unrecorded, never complete.
Fails when the document lacks source or columns, or holds a
field of the wrong type.