Struct DiagBuilder

pub struct DiagBuilder<'a, G: EmissionGuarantee> { /* private fields */ }

Used for emitting structured error messages and other diagnostic information.

Note: Incorrect usage of this type results in a panic when dropped. This is to ensure that all errors are either emitted or cancelled.

Implementations

impl<'a, G: EmissionGuarantee> DiagBuilder<'a, G>

pub fn new<M: Into<DiagMsg>>(dcx: &'a DiagCtxt, level: Level, msg: M) -> Self

Creates a new DiagBuilder.

pub fn dcx(&self) -> &DiagCtxt

Returns the DiagCtxt.

pub fn emit(self) -> G::EmitResult

Emits the diagnostic.

pub fn cancel(self)

Cancel the diagnostic (a structured diagnostic must either be emitted or cancelled or it will panic when dropped).

impl<G: EmissionGuarantee> DiagBuilder<'_, G>

Forwarded methods to Diag.

pub fn span(self, span: impl Into<MultiSpan>) -> Self

See Diag::span().

pub fn code(self, code: impl Into<DiagId>) -> Self

See Diag::code().

pub fn span_label(self, span: Span, label: impl Into<DiagMsg>) -> Self

See Diag::span_label().

pub fn span_labels( self, spans: impl IntoIterator<Item = Span>, label: impl Into<DiagMsg>, ) -> Self

See Diag::span_labels().

pub fn warn(self, msg: impl Into<DiagMsg>) -> Self

See Diag::warn().

pub fn span_warn( self, span: impl Into<MultiSpan>, msg: impl Into<DiagMsg>, ) -> Self

See Diag::span_warn().

pub fn note(self, msg: impl Into<DiagMsg>) -> Self

See Diag::note().

pub fn span_note( self, span: impl Into<MultiSpan>, msg: impl Into<DiagMsg>, ) -> Self

See Diag::span_note().

pub fn highlighted_note( self, messages: Vec<(impl Into<DiagMsg>, Style)>, ) -> Self

See Diag::highlighted_note().

pub fn note_once(self, msg: impl Into<DiagMsg>) -> Self

See Diag::note_once().

pub fn span_note_once( self, span: impl Into<MultiSpan>, msg: impl Into<DiagMsg>, ) -> Self

See Diag::span_note_once().

pub fn help(self, msg: impl Into<DiagMsg>) -> Self

See Diag::help().

pub fn help_once(self, msg: impl Into<DiagMsg>) -> Self

See Diag::help_once().

pub fn highlighted_help( self, messages: Vec<(impl Into<DiagMsg>, Style)>, ) -> Self

See Diag::highlighted_help().

pub fn span_help( self, span: impl Into<MultiSpan>, msg: impl Into<DiagMsg>, ) -> Self

See Diag::span_help().

Methods from Deref<Target = Diag>

pub fn is_error(&self) -> bool

Returns true if this diagnostic is an error.

pub fn label(&self) -> Cow<'_, str>

Formats the diagnostic messages into a single string.

pub fn messages(&self) -> &[(DiagMsg, Style)]

Returns the messages of this diagnostic.

pub fn level(&self) -> Level

Returns the level of this diagnostic.

pub fn id(&self) -> Option<String>

Returns the code of this diagnostic as a string.

pub fn span(&mut self, span: impl Into<MultiSpan>) -> &mut Self

Sets the span of this diagnostic.

pub fn code(&mut self, code: impl Into<DiagId>) -> &mut Self

Sets the code of this diagnostic.

pub fn span_label(&mut self, span: Span, label: impl Into<DiagMsg>) -> &mut Self

Adds a span/label to be included in the resulting snippet.

This is pushed onto the MultiSpan that was created when the diagnostic was first built. That means it will be shown together with the original span/label, not a span added by one of the span_{note,warn,help,suggestions} methods.

This span is not considered a “primary span”; only the Span supplied when creating the diagnostic is primary.

pub fn span_labels( &mut self, spans: impl IntoIterator<Item = Span>, label: impl Into<DiagMsg>, ) -> &mut Self

Labels all the given spans with the provided label. See Self::span_label() for more information.

pub fn warn(&mut self, msg: impl Into<DiagMsg>) -> &mut Self

Add a warning attached to this diagnostic.

pub fn span_warn( &mut self, span: impl Into<MultiSpan>, msg: impl Into<DiagMsg>, ) -> &mut Self

Prints the span with a warning above it. This is like Diag::warn(), but it gets its own span.

pub fn note(&mut self, msg: impl Into<DiagMsg>) -> &mut Self

Add a note to this diagnostic.

pub fn span_note( &mut self, span: impl Into<MultiSpan>, msg: impl Into<DiagMsg>, ) -> &mut Self

Prints the span with a note above it. This is like Diag::note(), but it gets its own span.

pub fn highlighted_note( &mut self, messages: Vec<(impl Into<DiagMsg>, Style)>, ) -> &mut Self

pub fn note_once(&mut self, msg: impl Into<DiagMsg>) -> &mut Self

Prints the span with a note above it. This is like Diag::note(), but it gets emitted only once.

pub fn span_note_once( &mut self, span: impl Into<MultiSpan>, msg: impl Into<DiagMsg>, ) -> &mut Self

Prints the span with a note above it. This is like Diag::note_once(), but it gets its own span.

pub fn help(&mut self, msg: impl Into<DiagMsg>) -> &mut Self

Add a help message attached to this diagnostic.

pub fn help_once(&mut self, msg: impl Into<DiagMsg>) -> &mut Self

Prints the span with a help above it. This is like Diag::help(), but it gets its own span.

pub fn highlighted_help( &mut self, msgs: Vec<(impl Into<DiagMsg>, Style)>, ) -> &mut Self

Add a help message attached to this diagnostic with a customizable highlighted message.

pub fn span_help( &mut self, span: impl Into<MultiSpan>, msg: impl Into<DiagMsg>, ) -> &mut Self

Prints the span with some help above it. This is like Diag::help(), but it gets its own span.

Trait Implementations

impl<G: EmissionGuarantee> Clone for DiagBuilder<'_, G>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<G: EmissionGuarantee> Debug for DiagBuilder<'_, G>

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

Formats the value using the given formatter.

impl<G: EmissionGuarantee> Deref for DiagBuilder<'_, G>

type Target = Diag

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<G: EmissionGuarantee> DerefMut for DiagBuilder<'_, G>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<G: EmissionGuarantee> Drop for DiagBuilder<'_, G>

fn drop(&mut self)

Executes the destructor for this type.