Struct Diagnostics 

pub struct Diagnostics { /* private fields */ }

A growing list of findings that keeps itself in reproducible order.

Callers push in whatever order problems are noticed; Diagnostics::finish imposes the order that makes two runs comparable.

The list is bounded. Past its ceiling, findings are counted rather than retained, and Diagnostics::finish appends one MOLFRAME-W1901 recording how many were suppressed. The worst severity still reflects every finding pushed, retained or not, so a decision taken on severity is unaffected by the ceiling.

Implementations

impl Diagnostics

pub const DEFAULT_CEILING: usize = 10_000

How many findings a list retains before it starts counting instead.

A systematically malformed column raises one finding per row, and a finding carries a message, a category, a field and a context vector — roughly ninety bytes and up to four allocations each. At a hundred million rows that is nine gigabytes of diagnostics describing a single cause, which exhausts memory reporting a problem rather than reporting it.

Ten thousand is far past the point where a reader learns anything new and far below the point where the list itself is the problem.

pub const fn new() -> Self

Creates an empty list with the default ceiling.

pub fn with_capacity(capacity: usize) -> Self

Creates a list with room for capacity findings.

Worth doing when a permissive parse over a known-messy file is expected to raise many, so the list does not grow by repeated reallocation. The ceiling is raised to capacity where that is higher than the default, because a caller who has reserved the room has said what they want.

pub const fn with_ceiling(self, ceiling: usize) -> Self

Sets how many findings this list retains before counting instead.

pub const fn ceiling(&self) -> usize

How many findings this list retains before counting instead.

pub const fn suppressed(&self) -> u64

How many findings were counted rather than retained.

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

Records a finding.

Past the ceiling the finding is counted and dropped. The severity is recorded either way, so nothing that depends on the worst severity changes with the ceiling.

pub const fn worst(&self) -> Option<Severity>

The worst severity recorded so far, if anything has been.

pub fn has_error(&self, strictness: Strictness) -> bool

Returns true when any recorded finding is an error at this strictness.

pub fn as_slice(&self) -> &[Diagnostic]

The findings recorded so far, in the order they were pushed.

pub fn is_empty(&self) -> bool

Returns true when nothing has been recorded.

pub fn len(&self) -> usize

The number of findings recorded.

pub fn finish(self) -> Vec<Diagnostic>

Consumes the list, returning the findings in reproducible order.

The sort is stable, so two findings identical on every ordering key stay in the order they were raised.

Trait Implementations

impl Clone for Diagnostics

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 Diagnostics

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

Formats the value using the given formatter.

impl Default for Diagnostics

fn default() -> Self

Returns the “default value” for a type.

impl Extend<Diagnostic> for Diagnostics

fn extend<T: IntoIterator<Item = Diagnostic>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: T)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.