Struct rustc_errors::annotate_snippet_emitter_writer::AnnotateSnippetEmitterWriter

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

Generates diagnostics using annotate-snippet

Fields

source_map: Option<Lrc<SourceMap>>

fluent_bundle: Option<Lrc<FluentBundle>>

fallback_bundle: LazyFallbackBundle

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>>,
    fluent_bundle: Option<Lrc<FluentBundle>>,
    fallback_bundle: LazyFallbackBundle,
    short_message: bool,
    macro_backtrace: bool
) -> Self

pub fn ui_testing(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,
    messages: &[(DiagnosticMessage, Style)],
    args: &FluentArgs<'_>,
    code: &Option<DiagnosticId>,
    msp: &MultiSpan,
    _children: &[SubDiagnostic],
    _suggestions: &[CodeSuggestion]
)

Trait Implementations

impl Emitter for AnnotateSnippetEmitterWriter

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

The entry point for the diagnostics generation

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

fn should_show_explain(&self) -> bool

Checks if should show explanations about “rustc –explain”

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.

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

fn emit_unused_externs(&mut self, _lint_level: Level, _unused_externs: &[&str])

Emit list of unused externs

fn supports_color(&self) -> bool

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

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

Formats the substitutions of the primary_span

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
)

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

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

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

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

impl Translate for AnnotateSnippetEmitterWriter

fn fluent_bundle(&self) -> Option<&Lrc<FluentBundle>>

Return FluentBundle with localized diagnostics for the locale requested by the user. If no language was requested by the user then this will be None and fallback_fluent_bundle should be used.

fn fallback_fluent_bundle(&self) -> &FluentBundle

Return FluentBundle with localized diagnostics for the default locale of the compiler. Used when the user has not requested a specific language or when a localized diagnostic is unavailable for the requested locale.

fn to_fluent_args<'arg>(&self, args: &[DiagnosticArg<'arg>]) -> FluentArgs<'arg>

Convert diagnostic arguments (a rustc internal type that exists to implement Encodable/Decodable) into FluentArgs which is necessary to perform translation.

fn translate_messages(
    &self,
    messages: &[(DiagnosticMessage, Style)],
    args: &FluentArgs<'_>
) -> Cow<'_, str>

Convert DiagnosticMessages to a string, performing translation if necessary.

fn translate_message<'a>(
    &'a self,
    message: &'a DiagnosticMessage,
    args: &'a FluentArgs<'_>
) -> Cow<'_, str>

Convert a DiagnosticMessage to a string, performing translation if necessary.

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: 32 bytes