Struct DiagnosticBuilder

pub struct DiagnosticBuilder<'a, A: ?Sized> {
    diagnostic: Diagnostic,
    base: &'a A,
}

Facility to create structured diagnostics including spans and multi-part messages. New builders are created with methods on Diagnostics. struct_<severity> creates simple main diagnostics with only a message, struct_node_<severity> creates a main diagnostic with a message and the span of a graph node and struct_span_<severity> creates a main diagnostic with a message and a custom source code span.

The builder allows chaining additional sub diagnostics to the main diagnostic. Analogous to the initializers the with_<severity> family of functions adds simple messages, with_node_<severity> adds messages with spans from a node and with_span_<severity> adds messages with custom spans.

Make sure to call Self::emit after construction, otherwise the diagnostic is not shown.

Fields

diagnostic: Diagnostic

base: &'a A

Implementations

impl<'a, A: ?Sized> DiagnosticBuilder<'a, A>

fn init( message: String, severity: Severity, span: Option<impl Into<HighlightedSpan>>, base: &'a A, ) -> Self

fn with_child( &mut self, message: impl Into<String>, severity: Severity, span: Option<impl Into<HighlightedSpan>>, ) -> &mut Self

impl<A: HasDiagnosticsBase + ?Sized> DiagnosticBuilder<'_, A>

pub fn emit(self)

Queue the diagnostic for display to the user.

pub fn with_help(&mut self, message: impl Into<String>) -> &mut Self

Append a help message to the diagnostic.

pub fn with_span_help( &mut self, span: Span, message: impl Into<String>, ) -> &mut Self

Append a help message with a source code span to the diagnostic.

pub fn with_node_help( &mut self, node: GlobalNode, message: impl Into<String>, ) -> &mut Self

Append a help message and the span of a graph node to the diagnostic.

pub fn with_warning(&mut self, message: impl Into<String>) -> &mut Self

Append a warning to the diagnostic.

pub fn with_span_warning( &mut self, span: Span, message: impl Into<String>, ) -> &mut Self

Append a warning and the span of a graph node to the diagnostic.

pub fn with_node_warning( &mut self, node: GlobalNode, message: impl Into<String>, ) -> &mut Self

Append a warning with a source code span to the diagnostic.

pub fn with_note(&mut self, message: impl Into<String>) -> &mut Self

Append a note to the diagnostic.

pub fn with_span_note( &mut self, span: Span, message: impl Into<String>, ) -> &mut Self

Append a note with a source code span to the diagnostic.

pub fn with_node_note( &mut self, node: GlobalNode, message: impl Into<String>, ) -> &mut Self

Append a note and the span of a graph node to the diagnostic.

fn with_node( &mut self, severity: Severity, node: GlobalNode, message: String, ) -> &mut Self

Trait Implementations

impl<'a, A: Debug + ?Sized> Debug for DiagnosticBuilder<'a, A>

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

Formats the value using the given formatter.