Struct rustc_errors::Diagnostic

pub struct Diagnostic {
    pub(crate) level: Level,
    pub messages: Vec<(DiagnosticMessage, Style)>,
    pub code: Option<ErrCode>,
    pub span: MultiSpan,
    pub children: Vec<SubDiagnostic>,
    pub suggestions: Result<Vec<CodeSuggestion>, SuggestionsDisabled>,
    args: FxIndexMap<DiagnosticArgName, DiagnosticArgValue>,
    pub sort_span: Span,
    pub is_lint: Option<IsLint>,
    pub(crate) emitted_at: DiagnosticLocation,
}

The main part of a diagnostic. Note that DiagnosticBuilder, which wraps this type, is used for most operations, and should be used instead whenever possible. This type should only be used when DiagnosticBuilder’s lifetime causes difficulties, e.g. when storing diagnostics within DiagCtxt.

Fields

level: Level

messages: Vec<(DiagnosticMessage, Style)>

code: Option<ErrCode>

span: MultiSpan

children: Vec<SubDiagnostic>

suggestions: Result<Vec<CodeSuggestion>, SuggestionsDisabled>

args: FxIndexMap<DiagnosticArgName, DiagnosticArgValue>

sort_span: Span

This is not used for highlighting or rendering any error message. Rather, it can be used as a sort key to sort a buffer of diagnostics. By default, it is the primary span of span if there is one. Otherwise, it is DUMMY_SP.

is_lint: Option<IsLint>

emitted_at: DiagnosticLocation

With -Ztrack_diagnostics enabled, we print where in rustc this error was emitted.

Implementations

impl Diagnostic

pub fn new<M: Into<DiagnosticMessage>>(level: Level, message: M) -> Self

pub fn new_with_messages( level: Level, messages: Vec<(DiagnosticMessage, Style)> ) -> Self

pub fn level(&self) -> Level

pub fn is_error(&self) -> bool

pub(crate) fn update_unstable_expectation_id( &mut self, unstable_to_stable: &FxIndexMap<LintExpectationId, LintExpectationId> )

pub(crate) fn has_future_breakage(&self) -> bool

Indicates whether this diagnostic should show up in cargo’s future breakage report.

pub(crate) fn is_force_warn(&self) -> bool

pub(crate) fn subdiagnostic_message_to_diagnostic_message( &self, attr: impl Into<SubdiagnosticMessage> ) -> DiagnosticMessage

pub(crate) fn sub( &mut self, level: Level, message: impl Into<SubdiagnosticMessage>, span: MultiSpan )

pub(crate) fn arg( &mut self, name: impl Into<DiagnosticArgName>, arg: impl IntoDiagnosticArg )

pub fn args(&self) -> impl Iterator<Item = DiagnosticArg<'_>>

pub fn replace_args( &mut self, args: FxIndexMap<DiagnosticArgName, DiagnosticArgValue> )

impl Diagnostic

fn keys( &self ) -> (&Level, &[(DiagnosticMessage, Style)], &Option<ErrCode>, &MultiSpan, &[SubDiagnostic], &Result<Vec<CodeSuggestion>, SuggestionsDisabled>, Vec<(&DiagnosticArgName, &DiagnosticArgValue)>, &Option<IsLint>)

Fields used for Hash, and PartialEq trait

Trait Implementations

impl Clone for Diagnostic

fn clone(&self) -> Diagnostic

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Diagnostic

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

Formats the value using the given formatter.

impl<__D: SpanDecoder> Decodable<__D> for Diagnostic

fn decode(__decoder: &mut __D) -> Self

impl<__E: SpanEncoder> Encodable<__E> for Diagnostic

fn encode(&self, __encoder: &mut __E)

impl Hash for Diagnostic

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Diagnostic

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 280 bytes