Struct DiagnosticData

pub struct DiagnosticData {
    pub message: String,
    pub spans: Vec<Span>,
    pub annotations: Vec<Annotation>,
    pub notes: Vec<(AnnotationKind, String)>,
    pub fixes: Vec<Fix>,
}

The data used to construct a diagnostic.

Fields

message: String

The main diagnostic message.

spans: Vec<Span>

Diagnostic’s spans

annotations: Vec<Annotation>

Annotations provided along the diagnostics

notes: Vec<(AnnotationKind, String)>

Spanless notes provided along the diagnostic

fixes: Vec<Fix>

Suggested fixes for the diagnostic

Implementations

impl DiagnosticData

pub fn new<S: ToString + ?Sized>(message: &S) -> Self

Creates an empty diagnostic with just a message.

pub fn add_note(self, kind: AnnotationKind, message: String) -> Self

Add a note (spanless annotation) to the diagnostic.

pub fn add_span(self, sp: Span) -> Self

Add a span for the diagnostic

pub fn add_annotation<S: ToString + ?Sized>( self, at: Span, kind: AnnotationKind, message: &S, ) -> Self

Add an annotation (message with a span).

pub fn add_annotation_opt_msg<S: ToString + ?Sized>( self, at: Span, kind: AnnotationKind, message: Option<&S>, ) -> Self

Add an annotation if message is Some

pub fn add_annotation_opt_span<S: ToString + ?Sized>( self, at: Option<Span>, kind: AnnotationKind, message: &S, ) -> Self

Add an annotation if span is Some

pub fn add_fix(self, fix: Fix) -> Self

Suggest a fix