Struct DataQualityResults 

pub struct DataQualityResults {

    pub total_rows: Option<usize>,
    pub evaluated_rows: usize,
    pub precision: QualityPrecision,
    pub columns: Vec<ColumnQualityProfile>,
    pub observations: Vec<QualityObservation>,
    pub segments: Vec<SegmentQualityProfile>,
    pub temporal: Vec<TemporalLatencyProfile>,
    pub identity: Option<IdentityProfile>,
    pub category_variants: Vec<CategoryVariantGroup>,
    pub shared_nulls: Vec<SharedNulls>,
    pub source_files: Option<usize>,
    pub per_value: Option<usize>,
    pub footers_read: Option<usize>,
    pub reads: Option<ObservedReads>,
    pub examples: Vec<FindingExamples>,
    pub unsampled_segments: Vec<UnsampledSegment>,
    pub intent: Option<Box<IntentResults>>,
    pub source: Option<Box<SourceIdentity>>,
    /* private fields */
}

Fields

total_rows: Option<usize>

evaluated_rows: usize

precision: QualityPrecision

columns: Vec<ColumnQualityProfile>

observations: Vec<QualityObservation>

segments: Vec<SegmentQualityProfile>

temporal: Vec<TemporalLatencyProfile>

identity: Option<IdentityProfile>

category_variants: Vec<CategoryVariantGroup>

shared_nulls: Vec<SharedNulls>

source_files: Option<usize>

How many source files’ footers were compared, when the scope has files to compare. None means the checks that compare files could not run.

per_value: Option<usize>

Rows an equal-per-value sample kept of each value. See crate::analysis::sampling::PerValue.

footers_read: Option<usize>

How many of source_files had their footers read: fewer on a dataset too large to read every footer, where the file checks cover only those.

reads: Option<ObservedReads>

What the run’s reads of the source were seen to do. None for results no watched run produced.

examples: Vec<FindingExamples>

Values behind text findings, from the rows the run kept; empty after a full scan.

unsampled_segments: Vec<UnsampledSegment>

Segments a sampled run counted rows in but drew none from, in order; not in segments, which profile only what was read.

intent: Option<Box<IntentResults>>

What the declared column intent found; None when nothing was declared.

source: Option<Box<SourceIdentity>>

What the rows were read from, as the run that measured them labeled it.

Implementations

impl DataQualityResults

pub fn estimated_bytes(&self) -> usize

Approximate memory the report holds, for budgeting: profiles per column and per segment column, plus kept text.

pub fn compare_segments(&mut self, plan: &DataQualityPlan)

pub fn empty(total_rows: Option<usize>, schema: &Schema) -> Self

pub fn examples_of(&self, kind: ObservationKind, column: &str) -> &[String]

The kept examples of kind in column.

impl DataQualityResults

pub fn edit<R>(&mut self, edit: impl FnOnce(&mut Self) -> R) -> R

Change these results in place: the report and checks are built again from what edit leaves.

pub fn report(&self) -> &QualityReport

The findings these results read as; see ReportCache.

pub fn checks(&self) -> &[Check]

Every check, most important first; see ReportCache.

Trait Implementations

impl Clone for DataQualityResults

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DataQualityResults

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

Formats the value using the given formatter.