Struct QualityReport 

pub struct QualityReport { /* private fields */ }

Results as a report: failures first, a table and a summary. See the module docs.

Implementations

impl QualityReport

pub fn new(results: impl IntoIterator<Item = CheckResult>) -> Self

A report of results, in order.

pub fn push(&mut self, result: CheckResult) -> &mut Self

Add a result.

pub fn show_rows(self, rows: usize) -> Self

The most failing rows shown per check (default FAILING_ROWS).

pub fn results(&self) -> &[CheckResult]

The results, in order.

pub fn totals(&self) -> Totals

How many ended each way.

pub fn is_success(&self) -> bool

Whether nothing failed or errored (warnings pass).

pub fn summary(&self) -> String

The summary: 3 passed, 1 warned, 2 failed, with errors when any.

pub fn to_json(&self) -> Value

The results as JSON: results and totals.

pub fn to_table(&self, console: &Console) -> Table

A table of every check: status, check, column, observed, expected.

Trait Implementations

impl Clone for QualityReport

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 QualityReport

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

Formats the value using the given formatter.

impl PartialEq for QualityReport

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

Equality operator ==.

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

Inequality operator !=.

impl Renderable for QualityReport

fn rich_render( &self, console: &Console, options: &ConsoleOptions, ) -> Vec<Segment>

fn measure(&self, console: &Console, options: &ConsoleOptions) -> Measurement

The (minimum, maximum) cell width this renderable wants. Port of __rich_measure__. The default is what upstream’s Measurement.get returns for a renderable without one: anything from nothing to the whole width, (0, max_width).

fn fit_to_measurement(&self) -> bool

Whether a top-level Console::print shrinks this renderable to its measured width. Upstream renders every top-level renderable at the full console width, so the default is false; an extension may opt in.

fn vertical(&self) -> Option<VerticalAlign>

The vertical alignment a Table cell holding this renderable uses in place of its column’s. Upstream reads getattr(renderable, "vertical", None); Align sets it.

fn print_end_line(&self, _options: &ConsoleOptions) -> bool

Whether a top-level print ends this renderable’s last line. This port’s renderables separate lines, where upstream’s end each line with "\n", so a print adds the final line break. A renderable whose upstream output stops without one (Screen, LiveRender, a Rule whose end has no newline) returns false, and the next output continues its last line. options are the print’s options.

impl StructuralPartialEq for QualityReport