Struct Diagnostic 

pub struct Diagnostic { /* private fields */ }

One finding about the data.

A finding always has a code, and through the code always has a cause and a remedy — neither is something a call site can forget to supply. The message is optional and defaults to the code’s registered cause, so raising a finding that needs no elaboration allocates nothing.

Examples

use molframe_core::{Code, Diagnostic, Severity};

let finding = Diagnostic::new(Code::W3203).in_category("atom_site").at_row(17);
assert_eq!(finding.severity(), Severity::Loose);
assert_eq!(finding.message(), "element inferred from the atom name");
assert!(!finding.remedy().is_empty());

Implementations

impl Diagnostic

pub fn retained_bytes(&self) -> usize

Heap bytes retained by this occurrence’s owned details.

pub fn new(code: Code) -> Self

Creates a finding carrying the code’s registered severity and cause.

pub fn with_message(self, message: impl Into<Box<str>>) -> Self

Replaces the message with one describing this occurrence.

Use it when the specifics matter; leave it alone when the registered cause already says everything there is to say.

pub const fn with_severity(self, severity: Severity) -> Self

Overrides the severity for this occurrence.

The registry decides severity in general. This exists for the cases where the same code is genuinely worse in one context than another.

pub fn at(self, span: ByteSpan) -> Self

Records where in the source this finding was raised.

pub fn in_category(self, category: impl Into<Box<str>>) -> Self

Records the category this finding concerns.

pub fn about_field(self, field: impl Into<Box<str>>) -> Self

Records the item this finding concerns.

pub const fn at_row(self, row: u64) -> Self

Records the row this finding concerns.

pub fn with_context( self, label: &'static str, value: impl Into<Box<str>>, ) -> Self

Attaches a labelled detail.

pub const fn code(&self) -> Code

The stable code.

pub const fn severity(&self) -> Severity

How bad this finding is.

pub fn message(&self) -> &str

What happened.

pub fn remedy(&self) -> &'static str

What to do about it.

pub fn span(&self) -> Option<ByteSpan>

Where in the source this was raised, if a position was known.

pub fn category(&self) -> Option<&str>

The category this concerns, if any.

pub fn field(&self) -> Option<&str>

The item this concerns, if any.

pub const fn row(&self) -> Option<u64>

The row this concerns, if any.

pub fn context(&self) -> &[ContextItem]

The labelled details attached to this finding.

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

Returns true when this finding is an error at the given strictness.

Trait Implementations

impl Clone for Diagnostic

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 Diagnostic

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

Formats the value using the given formatter.

impl Display for Diagnostic

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

Formats the value using the given formatter.

impl Eq for Diagnostic

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.

impl From<&!> for Diagnostic

fn from(never: &Infallible) -> Self

An error that cannot be constructed has no code to name.

impl From<&ContextError> for Diagnostic

fn from(_error: &ContextError) -> Self

Converts to this type from the input type.

impl From<&Diagnostic> for Diagnostic

fn from(diagnostic: &Diagnostic) -> Self

A finding is already a diagnostic; kernels that fail with one convert by copy.

impl From<&MemoryBudgetError> for Diagnostic

fn from(_error: &MemoryBudgetError) -> Self

Converts to this type from the input type.

impl From<&PolicyParseError> for Diagnostic

fn from(_error: &PolicyParseError) -> Self

Converts to this type from the input type.

impl From<&StructureBatchError> for Diagnostic

fn from(error: &StructureBatchError) -> Self

A wrapped diagnostic is returned as it is, so its code, remedy and span survive; the rest name the kind of limit that stopped the read.

impl From<ContextError> for Diagnostic

fn from(value: ContextError) -> Self

Converts to this type from the input type.

impl From<Diagnostic> for Findings

fn from(finding: Diagnostic) -> Self

Converts to this type from the input type.

impl From<Diagnostic> for StructureBatchError

fn from(error: Diagnostic) -> Self

Converts to this type from the input type.

impl From<MemoryBudgetError> for Diagnostic

fn from(value: MemoryBudgetError) -> Self

Converts to this type from the input type.

impl From<PolicyParseError> for Diagnostic

fn from(value: PolicyParseError) -> Self

Converts to this type from the input type.

impl From<StructureBatchError> for Diagnostic

fn from(error: StructureBatchError) -> Self

Converts to this type from the input type.

impl PartialEq for Diagnostic

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Diagnostic