Struct rustc_errors::annotate_snippet_emitter_writer::AnnotateSnippetEmitterWriter

pub struct AnnotateSnippetEmitterWriter {
    source_map: Option<Lrc<SourceMap>>,
    short_message: bool,
    ui_testing: bool,
    macro_backtrace: bool,
}

Generates diagnostics using annotate-snippet

Fields

source_map: Option<Lrc<SourceMap>>

short_message: bool

If true, hides the longer explanation text

ui_testing: bool

If true, will normalize line numbers with LL to prevent noise in UI test diffs.

macro_backtrace: bool

Implementations

impl AnnotateSnippetEmitterWriter

pub fn new(
    source_map: Option<Lrc<SourceMap>>,
    short_message: bool,
    macro_backtrace: bool
) -> Self

pub fn ui_testing(mut self: Self, ui_testing: bool) -> Self

Allows to modify Self to enable or disable the ui_testing flag.

If this is set to true, line numbers will be normalized as LL in the output.

fn emit_messages_default(
    &mut self,
    level: &Level,
    message: String,
    code: &Option<DiagnosticId>,
    msp: &MultiSpan,
    _children: &[SubDiagnostic],
    _suggestions: &[CodeSuggestion]
)

Trait Implementations

impl Emitter for AnnotateSnippetEmitterWriter

pub fn emit_diagnostic(&mut self, diag: &Diagnostic)

The entry point for the diagnostics generation

pub fn source_map(&self) -> Option<&Lrc<SourceMap>>

pub fn should_show_explain(&self) -> bool

Checks if should show explanations about "rustc --explain"

pub fn emit_artifact_notification(&mut self, _path: &Path, _artifact_type: &str)

Emit a notification that an artifact has been output. This is currently only supported for the JSON format, other formats can, and will, simply ignore it.

pub fn emit_future_breakage_report(
    &mut self,
    _diags: Vec<(FutureBreakage, Diagnostic)>
)

pub fn supports_color(&self) -> bool

Checks if we can use colors in the current output stream.

pub fn primary_span_formatted<'a>(
    &mut self,
    diag: &'a Diagnostic
) -> (MultiSpan, &'a [CodeSuggestion])

Formats the substitutions of the primary_span

pub fn fix_multispans_in_extern_macros_and_render_macro_backtrace(
    &self,
    source_map: &Option<Lrc<SourceMap>>,
    span: &mut MultiSpan,
    children: &mut Vec<SubDiagnostic>,
    level: &Level,
    backtrace: bool
)

pub fn render_multispans_macro_backtrace(
    &self,
    span: &mut MultiSpan,
    children: &mut Vec<SubDiagnostic>,
    backtrace: bool
)

pub fn render_multispan_macro_backtrace(
    &self,
    span: &mut MultiSpan,
    always_backtrace: bool
)

pub fn fix_multispans_in_extern_macros(
    &self,
    source_map: &Option<Lrc<SourceMap>>,
    span: &mut MultiSpan,
    children: &mut Vec<SubDiagnostic>
)

pub fn fix_multispan_in_extern_macros(
    &self,
    source_map: &Option<Lrc<SourceMap>>,
    span: &mut MultiSpan
)