Crate rustc_errors 

Diagnostics creation and emission for rustc.

This module contains the code for creating and emitting diagnostics.

Re-exports

pub use decorate_diag::BufferedEarlyLint;

pub use decorate_diag::DecorateDiagCompat;

pub use decorate_diag::LintBuffer;

pub use diagnostic::Diag;

pub use diagnostic::DiagDecorator;

pub use diagnostic::DiagInner;

pub use diagnostic::DiagLocation;

pub use diagnostic::DiagStyledString;

pub use diagnostic::Diagnostic;

pub use diagnostic::StringPart;

pub use diagnostic::Subdiag;

pub use diagnostic::Subdiagnostic;

pub use diagnostic_impls::DiagSymbolList;

pub use diagnostic_impls::ElidedLifetimeInPathSubdiag;

pub use diagnostic_impls::ExpectedLifetimeParameter;

pub use diagnostic_impls::IndicateAnonymousLifetime;

pub use diagnostic_impls::SingleLabelManySpans;

pub use emitter::ColorConfig;

pub(crate) use emitter::DynEmitter; 🔒

pub(crate) use emitter::Emitter; 🔒

pub(crate) use crate::emitter::TimingEvent; 🔒

pub(crate) use crate::formatting::DiagMessageAddArg; 🔒

pub use crate::formatting::format_diag_message;

pub(crate) use crate::timings::TimingRecord; 🔒

pub(crate) use Backtrace; 🔒

pub(crate) use BacktraceStatus; 🔒

pub(crate) use std::borrow::Cow; 🔒

pub(crate) use std::cell::Cell; 🔒

pub(crate) use std::ffi::OsStr; 🔒

pub(crate) use std::hash::Hash; 🔒

pub(crate) use std::hash::Hash; 🔒

pub(crate) use std::io::Write; 🔒

pub(crate) use std::num::NonZero; 🔒

pub(crate) use std::ops::DerefMut; 🔒

pub(crate) use Path; 🔒

pub(crate) use PathBuf; 🔒

pub(crate) use std::thread::ThreadId; 🔒

pub(crate) use assert_matches; 🔒

pub(crate) use fmt; 🔒

pub(crate) use mem; 🔒

pub(crate) use panic; 🔒

pub(crate) use panic; 🔒

pub(crate) use rustc_ast::attr::version::RustcVersion; 🔒

pub(crate) use rustc_data_structures::AtomicRef; 🔒

pub(crate) use FxHashSet; 🔒

pub(crate) use FxIndexMap; 🔒

pub(crate) use FxIndexSet; 🔒

pub(crate) use DynSend; 🔒

pub(crate) use Lock; 🔒

pub use fluent_bundle;

pub(crate) use rustc_hashes::Hash128; 🔒

pub(crate) use rustc_lint_defs::LintExpectationId; 🔒

pub(crate) use Decodable; 🔒

pub(crate) use Encodable; 🔒

pub(crate) use rustc_span::source_map::SourceMap; 🔒

pub(crate) use DUMMY_SP; 🔒

pub(crate) use Span; 🔒

pub(crate) use tracing::debug; 🔒

pub(crate) use Level::*; 🔒

pub use codes::*;

Modules

annotate_snippet_emitter_writer

Emit diagnostics using the annotate-snippets library

codes

This module defines the following.

decorate_diag 🔒

dedup_hash 🔒

diagnostic 🔒

diagnostic_impls 🔒

emitter

The current rustc diagnostics emitter.

formatting

json

A JSON emitter for errors.

lock 🔒

Bindings to acquire a global named lock.

markdown

A simple markdown parser that can write formatted text to the terminal

timings

Macros

into_diag_arg_using_display

msg

This macro creates a translatable DiagMessage from a fluent format string. It should be used in places where a translatable message is needed, but struct diagnostics are undesired.

pluralize

struct_span_code_err

Structs

Ansi256Color

256 (8-bit) color support

Anstyle

ANSI Text styling

AutoStream

std::io::Write that adapts ANSI escape codes to the underlying Writes capabilities

CodeSuggestion

DelayedBugPanic

Signifies that the compiler died due to a delayed bug rather than a failed assertion, etc.

DelayedDiagInner 🔒

DiagArgFromDisplay

DiagCtxt

A DiagCtxt deals with errors and other compiler output. Certain errors (fatal, bug, unimpl) may cause immediate exit, others log errors for later reporting.

DiagCtxtFlags

DiagCtxtHandle

DiagCtxtInner 🔒

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.

EffectIter

Enumerate each enabled value in Effects

Effects

A set of text effects

ErrorGuaranteed

Useful type to use with Result<> indicate that an error has already been reported to the user, so no need to continue checking.

ExplicitBug

Signifies that the compiler died with an explicit call to .bug or .span_bug rather than a failed assertion, etc.

FatalError

Used as a return value to signify a fatal error occurred.

FatalErrorMarker

This is a marker for a fatal compiler error used with resume_unwind.

LanguageIdentifier

LanguageIdentifier is a core struct representing a Unicode Language Identifier.

MultiSpan

A collection of Spans.

Reset

Reset terminal formatting

RgbColor

24-bit ANSI RGB color codes

SpanLabel

A span together with some additional data.

Substitution

See the docs on CodeSuggestion::substitutions

SubstitutionPart

TrimmedSubstitutionPart

Enums

AnsiColor

Available 4-bit ANSI color palette codes

Applicability

Indicates the confidence in the correctness of a suggestion.

Color

Any ANSI color code scheme

ColorChoice

Selection for overriding color output Selection for overriding color output

DiagArgValue

Simplified version of FluentValue that can implement Encodable and Decodable. Converted to a FluentValue by the emitter to be used in diagnostic translation.

DiagMessage

Abstraction over a message in a diagnostic to support both translatable and non-translatable diagnostic messages.

EmissionOverride

Special emission behaviours on warning diagnostics. Combines with DiagInner::is_lint in the following ways.

Level

StashKey

A key denoting where from a diagnostic was stashed.

Style

Sublevel

The level for a subdiagnostic.

SuggestionStyle

Suggestions

Represents the help messages seen on a diagnostic.

TerminalUrl

Statics

TRACK_DIAGNOSTIC

Diagnostics emitted by DiagCtxtInner::emit_diagnostic are passed through this function. Used for tracking by incremental, to replay diagnostics as necessary.

Traits

IntoDiagArg

Converts a value of a type into a DiagArg (typically a field of an Diag struct). Implemented as a custom trait rather than From so that it is implemented on the type being converted rather than on DiagArgValue, which enables types from other rustc_* crates to implement this.

Functions

a_or_an

Grammatical tool for displaying messages to end users in a nice form.

as_substr 🔒

Given an original string like AACC, and a suggestion like AABBCC, try to detect the case where a substring of the suggestion is “sandwiched” in the original, like BB is. Return the length of the prefix, the “trimmed” suggestion, and the length of the suffix.

catch_fatal_errors

Runs a closure and catches unwinds triggered by fatal errors.

default_track_diagnostic 🔒

elided_lifetime_in_path_suggestion

listify

Grammatical tool for displaying messages to end users in a nice form.

Type Aliases

DiagArg

Simplified version of FluentArg that can implement Encodable and Decodable. Collection of DiagArg are converted to FluentArgs (consuming the collection) at the start of diagnostic emission.

DiagArgMap

A mapping from diagnostic argument names to their values. This contains all the arguments necessary to format a diagnostic message.

DiagArgName

Name of a diagnostic argument.

PResult