Expand description
Diagnostics creation and emission for rustc
.
This module contains the code for creating and emitting diagnostics.
Re-exports§
pub use emitter::ColorConfig;
pub use rustc_error_messages::fluent_bundle;
pub use codes::*;
Modules§
- Emit diagnostics using the
annotate-snippets
library - This module defines the following.
- The current rustc diagnostics emitter.
- A JSON emitter for errors.
- lock 🔒Bindings to acquire a global named lock.
- A simple markdown parser that can write formatted text to the terminal
- snippet 🔒
Macros§
Structs§
- Marker type which enables implementation of
create_bug
andemit_bug
functions for bug diagnostics. - A color specification.
- Signifies that the compiler died due to a delayed bug rather than a failed assertion, etc.
- Used for emitting structured error messages and other diagnostic information. Wraps a
DiagInner
, adding some useful things. - A
DiagCtxt
deals with errors and other compiler output. Certain errors (fatal, bug, unimpl) may cause immediate exit, others log errors for later reporting. - This inner struct exists to keep it all behind a single lock; this is done to prevent possible deadlocks in a multi-threaded compiler, as well as inconsistent state observation.
- The main part of a diagnostic. Note that
Diag
, which wraps this type, is used for most operations, and should be used instead whenever possible. This type should only be used whenDiag
’s lifetime causes difficulties, e.g. when storing diagnostics withinDiagCtxt
. - Useful type to use with
Result<>
indicate that an error has already been reported to the user, so no need to continue checking. - Signifies that the compiler died with an explicit call to
.bug
or.span_bug
rather than a failed assertion, etc. - Marker type which enables implementation of
create_fatal
andemit_fatal
functions for fatal diagnostics. - Used as a return value to signify a fatal error occurred.
- This is a marker for a fatal compiler error used with
resume_unwind
. LanguageIdentifier
is a core struct representing a Unicode Language Identifier.- A collection of
Span
s. - Utility struct used to apply a single label while highlighting multiple spans
- A span together with some additional data.
- A “sub”-diagnostic attached to a parent diagnostic. For example, a note attached to an error.
- See the docs on
CodeSuggestion::substitutions
- Used to translate between
Span
s and byte positions within a single output line in highlighted code of structured suggestions.
Enums§
- Indicates the confidence in the correctness of a suggestion.
- The set of available colors for the terminal foreground/background.
- Simplified version of
FluentValue
that can implementEncodable
andDecodable
. Converted to aFluentValue
by the emitter to be used in diagnostic translation. - Abstraction over a message in a diagnostic to support both translatable and non-translatable diagnostic messages.
- A key denoting where from a diagnostic was stashed.
- Abstraction over a message in a subdiagnostic (i.e. label, note, help, etc) to support both translatable and non-translatable diagnostic messages.
- Represents the help messages seen on a diagnostic.
Statics§
- Raw content of Fluent resource for this crate, generated by
fluent_messages
macro, imported byrustc_driver
to include all crates’ resources in one bundle. - Diagnostics emitted by
DiagCtxtInner::emit_diagnostic
are passed through this function. Used for tracking by incremental, to replay diagnostics as necessary.
Traits§
- Trait implemented by error types. This is rarely implemented manually. Instead, use
#[derive(Diagnostic)]
– see rustc_macros::Diagnostic. - Trait for types that
Diag::emit
can return as a “guarantee” (or “proof”) token that the emission happened. - Converts a value of a type into a
DiagArg
(typically a field of anDiag
struct). Implemented as a custom trait rather thanFrom
so that it is implemented on the type being converted rather than onDiagArgValue
, which enables types from otherrustc_*
crates to implement this. - Trait implemented by lint types. This should not be implemented manually. Instead, use
#[derive(LintDiagnostic)]
– see rustc_macros::LintDiagnostic. - Trait implemented by error types. This should not be implemented manually. Instead, use
#[derive(Subdiagnostic)]
– see rustc_macros::Subdiagnostic. - This trait describes the behavior of writers that support colored output.
Functions§
- Grammatical tool for displaying messages to end users in a nice form.
- Grammatical tool for displaying messages to end users in a nice form.
- Return the default
FluentBundle
with standard “en-US” diagnostic messages. - Returns Fluent bundle with the user’s locale resources from
$sysroot/share/locale/$requested_locale/*.ftl
.
Type Aliases§
- Simplified version of
FluentArg
that can implementEncodable
andDecodable
. Collection ofDiagArg
are converted toFluentArgs
(consuming the collection) at the start of diagnostic emission. - Name of a diagnostic argument.
- Type alias for the result of
fallback_fluent_bundle
- a reference-counted pointer to a lazily evaluated fluent bundle.