Struct swc_common::errors::DiagnosticBuilder[−][src]

pub struct DiagnosticBuilder<'a> {
    pub handler: &'a Handler,
    // some fields omitted
}
Expand description

Used for emitting structured error messages and other diagnostic information.

If there is some state in a downstream crate you would like to access in the methods of DiagnosticBuilder here, consider extending HandlerFlags, accessed via self.handler.flags.

Fields

handler: &'a Handler

Implementations

Emit the diagnostic.

Buffers the diagnostic for later emission, unless handler has disabled such buffering.

Convenience function for internal use, clients should use one of the span_* methods instead.

Delay emission of this diagnostic as a bug.

This can be useful in contexts where an error indicates a bug but typically this only happens when other compilation errors have already happened. In those cases this can be used to defer emission of this diagnostic as a bug in the compiler only if no other errors have been emitted.

In the meantime, though, callsites are required to deal with the “bug” locally in whichever way makes the most sense.

Add 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. If you don’t call this function at all, and you just supplied a Span to create the diagnostic, then the snippet will just include that Span, which is called the primary span.

Convenience function for internal use, clients should use one of the struct_* methods on Handler.

Convenience function for internal use, clients should use one of the struct_* methods on Handler.

Creates a new DiagnosticBuilder with an already constructed diagnostic.

Methods from Deref<Target = Diagnostic>

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

Add 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. If you don’t call this function at all, and you just supplied a Span to create the diagnostic, then the snippet will just include that Span, which is called the primary span.

👎 Deprecated:

Use span_suggestion_short_with_applicability

Prints out a message with a suggested edit of the code. If the suggestion is presented inline it will only show the text message and not the text.

See CodeSuggestion for more information.

👎 Deprecated:

Use span_suggestion_with_applicability

Prints out a message with a suggested edit of the code.

In case of short messages and a simple suggestion, rustc displays it as a label like

“try adding parentheses: (tup.0).1”

The message

  • should not end in any punctuation (a : is added automatically)
  • should not be a question
  • should not contain any parts like “the following”, “as shown”
  • may look like “to do xyz, use” or “to do xyz, use abc”
  • may contain a name of a function, variable or type, but not whole expressions

See CodeSuggestion for more information.

👎 Deprecated:

Use multipart_suggestion_with_applicability

👎 Deprecated:

Use span_suggestions_with_applicability

Prints out a message with multiple suggested edits of the code.

This is a suggestion that may contain mistakes or fillers and should be read and understood by a human.

Used by a lint. Copies over all details but the “main message”.

Convenience function for internal use, clients should use one of the public methods above.

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

The resulting type after dereferencing.

Dereferences the value.

Mutably dereferences the value.

Destructor bomb - a DiagnosticBuilder must be either emitted or canceled or we emit a bug.

Executes the destructor for this type. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

The owned type, stored in RCow::Owned

The borrowed type, stored in RCow::Borrowed

Performs the conversion.

This is always WithMetadata_<Self, Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Performs the conversion.

Gets a reference to a field, determined by offset. Read more

Gets a muatble reference to a field, determined by offset. Read more

Gets a const pointer to a field, the field is determined by offset. Read more

Gets a mutable pointer to a field, determined by offset. Read more

Replaces a field (determined by offset) with value, returning the previous value of the field. Read more

Swaps a field (determined by offset) with the same field in right. Read more

Gets a copy of a field (determined by offset). The field is determined by offset. Read more

Replaces a field (determined by offset) with value, returning the previous value of the field. Read more

Swaps a field (determined by offset) with the same field in right. Read more

Gets a copy of a field (determined by offset). The field is determined by offset. Read more

Compares the address of self with the address of other. Read more

Emulates the pipeline operator, allowing method syntax in more places. Read more

The same as piped except that the function takes &Self Useful for functions that take &Self instead of Self. Read more

The same as piped, except that the function takes &mut Self. Useful for functions that take &mut Self instead of Self. Read more

Mutates self using a closure taking self by mutable reference, passing it along the method chain. Read more

Observes the value of self, passing it along unmodified. Useful in long method chains. Read more

fn into_<T>(self) -> T where
    Self: Into<T>, 

Performs a conversion with Into. using the turbofish .into_::<_>() syntax. Read more

fn as_ref_<T>(&self) -> &T where
    Self: AsRef<T>,
    T: ?Sized, 

Performs a reference to reference conversion with AsRef, using the turbofish .as_ref_::<_>() syntax. Read more

fn as_mut_<T>(&mut self) -> &mut T where
    Self: AsMut<T>,
    T: ?Sized, 

Performs a mutable reference to mutable reference conversion with AsMut, using the turbofish .as_mut_::<_>() syntax. Read more

fn drop_(self)

Drops self using method notation. Alternative to std::mem::drop. Read more

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

Transmutes the element type of this pointer.. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

This is always Self.

Converts a value back to the original type.

Converts a reference back to the original type.

Converts a mutable reference back to the original type.

Converts a box back to the original type.

Converts an Arc back to the original type. Read more

Converts an Rc back to the original type. Read more

Converts a value back to the original type.

Converts a reference back to the original type.

Converts a mutable reference back to the original type.

Converts a box back to the original type.

Converts an Arc back to the original type.

Converts an Rc back to the original type.

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more