Struct Diag 

pub struct Diag {
    pub code: &'static str,
    pub severity: Severity,
    pub message: String,
    pub source_name: Option<String>,
    pub source_text: Option<Arc<str>>,
    pub span: Option<Span>,
    pub help: Option<String>,
}

One structured, source-located finding.

Fields

code: &'static str

Stable, greppable code (proef::pack::…, proef::feature::…, …).

severity: Severity

Severity.

message: String

Human-readable message.

source_name: Option<String>

Name of the source this points into (file path as authored), if any.

source_text: Option<Arc<str>>

The (normalized) source text, shared across diags of one file.

span: Option<Span>

Labeled byte region within source_text.

help: Option<String>

Remediation hint.

Implementations

impl Diag

pub fn error(code: &'static str, message: impl Into<String>) -> Self

An error diagnostic.

pub fn warning(code: &'static str, message: impl Into<String>) -> Self

A warning diagnostic.

pub fn with_source(self, name: impl Into<String>, text: Arc<str>) -> Self

Attach the source this diagnostic points into.

pub fn with_span(self, span: Span) -> Self

Attach a labeled span (clamped by the caller against the source length).

pub fn with_help(self, help: impl Into<String>) -> Self

Attach a remediation hint.

Trait Implementations

impl Clone for Diag

fn clone(&self) -> Diag

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Diag

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

Formats the value using the given formatter.

impl Eq for Diag

impl PartialEq for Diag

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Diag