Struct Diagnostic 

#[non_exhaustive]
pub struct Diagnostic {
    pub severity: Severity,
    pub code: Arc<str>,
    pub message: Arc<str>,
    pub span: Option<Span>,
    pub suggestion: Option<Arc<str>>,
    pub limit_kind: Option<LimitKind>,
}

A non-fatal diagnostic.

code is a stable, machine-readable identifier like "TF1001"; tooling uses it to allowlist / ignore specific diagnostics without matching the message string. limit_kind is set on diagnostics emitted in response to a configured cap breach, so consumers can pivot on the structured kind rather than parsing the message.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

severity: Severity

Severity.

code: Arc<str>

Stable identifier (e.g. "TF1001", "TG2003").

message: Arc<str>

Human-readable message; safe to log at the diagnostic’s severity.

span: Option<Span>

Optional location.

suggestion: Option<Arc<str>>

Optional fix-it / suggestion to surface in CLI output.

limit_kind: Option<LimitKind>

Set when this diagnostic is the result of a configured-cap breach (max_blocks_per_file, max_attr_depth, etc.). Lets consumers disambiguate without parsing the message.

Implementations

impl Diagnostic

pub fn builder() -> DiagnosticBuilder<((), (), (), (), (), ())>

Create a builder for building Diagnostic. On the builder, call .severity(...), .code(...), .message(...), .span(...)(optional), .suggestion(...)(optional), .limit_kind(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of Diagnostic.

impl Diagnostic

pub fn new( severity: Severity, code: impl Into<Arc<str>>, message: impl Into<Arc<str>>, ) -> Self

Construct a diagnostic.

pub fn limit( kind: LimitKind, code: impl Into<Arc<str>>, message: impl Into<Arc<str>>, ) -> Self

Construct a diagnostic for a configured-cap breach.

The structured LimitKind is preserved as self.limit_kind so downstream tooling can match on it directly. The message should still spell out the observed/limit values for log readability.

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

Add a span.

pub fn with_suggestion(self, suggestion: impl Into<Arc<str>>) -> Self

Add a suggestion.

Trait Implementations

impl Clone for Diagnostic

fn clone(&self) -> Diagnostic

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<'de> Deserialize<'de> for Diagnostic

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for Diagnostic

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Diagnostic

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Diagnostic

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Diagnostic

impl StructuralPartialEq for Diagnostic