Struct rustc_errors::emitter::EmitterWriter
source · pub struct EmitterWriter {
dst: Destination,
sm: Option<Lrc<SourceMap>>,
fluent_bundle: Option<Lrc<FluentBundle>>,
fallback_bundle: LazyFallbackBundle,
short_message: bool,
teach: bool,
ui_testing: bool,
diagnostic_width: Option<usize>,
macro_backtrace: bool,
}
Expand description
Handles the writing of HumanReadableErrorType::Default
and HumanReadableErrorType::Short
Fields
dst: Destination
sm: Option<Lrc<SourceMap>>
fluent_bundle: Option<Lrc<FluentBundle>>
fallback_bundle: LazyFallbackBundle
short_message: bool
teach: bool
ui_testing: bool
diagnostic_width: Option<usize>
macro_backtrace: bool
Implementations
sourceimpl EmitterWriter
impl EmitterWriter
pub fn stderr(
color_config: ColorConfig,
source_map: Option<Lrc<SourceMap>>,
fluent_bundle: Option<Lrc<FluentBundle>>,
fallback_bundle: LazyFallbackBundle,
short_message: bool,
teach: bool,
diagnostic_width: Option<usize>,
macro_backtrace: bool
) -> EmitterWriter
pub fn new(
dst: Box<dyn Write + Send>,
source_map: Option<Lrc<SourceMap>>,
fluent_bundle: Option<Lrc<FluentBundle>>,
fallback_bundle: LazyFallbackBundle,
short_message: bool,
teach: bool,
colored: bool,
diagnostic_width: Option<usize>,
macro_backtrace: bool
) -> EmitterWriter
pub fn ui_testing(self, ui_testing: bool) -> Self
fn maybe_anonymized(&self, line_num: usize) -> Cow<'static, str>
fn draw_line(
&self,
buffer: &mut StyledBuffer,
source_string: &str,
line_index: usize,
line_offset: usize,
width_offset: usize,
code_offset: usize,
margin: Margin
)
fn render_source_line(
&self,
buffer: &mut StyledBuffer,
file: Lrc<SourceFile>,
line: &Line,
width_offset: usize,
code_offset: usize,
margin: Margin
) -> Vec<(usize, Style)>
fn get_multispan_max_line_num(&mut self, msp: &MultiSpan) -> usize
fn get_max_line_num(
&mut self,
span: &MultiSpan,
children: &[SubDiagnostic]
) -> usize
sourcefn msg_to_buffer(
&self,
buffer: &mut StyledBuffer,
msg: &[(DiagnosticMessage, Style)],
args: &FluentArgs<'_>,
padding: usize,
label: &str,
override_style: Option<Style>
)
fn msg_to_buffer(
&self,
buffer: &mut StyledBuffer,
msg: &[(DiagnosticMessage, Style)],
args: &FluentArgs<'_>,
padding: usize,
label: &str,
override_style: Option<Style>
)
Adds a left margin to every line but the first, given a padding length and the label being displayed, keeping the provided highlighting.
fn emit_message_default(
&mut self,
msp: &MultiSpan,
msg: &[(DiagnosticMessage, Style)],
args: &FluentArgs<'_>,
code: &Option<DiagnosticId>,
level: &Level,
max_line_num_len: usize,
is_secondary: bool
) -> Result<()>
fn emit_suggestion_default(
&mut self,
span: &MultiSpan,
suggestion: &CodeSuggestion,
args: &FluentArgs<'_>,
level: &Level,
max_line_num_len: usize
) -> Result<()>
fn emit_messages_default(
&mut self,
level: &Level,
message: &[(DiagnosticMessage, Style)],
args: &FluentArgs<'_>,
code: &Option<DiagnosticId>,
span: &MultiSpan,
children: &[SubDiagnostic],
suggestions: &[CodeSuggestion]
)
fn draw_code_line(
&self,
buffer: &mut StyledBuffer,
row_num: &mut usize,
highlight_parts: &Vec<SubstitutionHighlight>,
line_pos: usize,
line: &str,
line_start: usize,
show_code_change: DisplaySuggestion,
max_line_num_len: usize,
file_lines: &FileLines,
is_multiline: bool
)
Trait Implementations
sourceimpl Emitter for EmitterWriter
impl Emitter for EmitterWriter
fn source_map(&self) -> Option<&Lrc<SourceMap>>
sourcefn emit_diagnostic(&mut self, diag: &Diagnostic)
fn emit_diagnostic(&mut self, diag: &Diagnostic)
Emit a structured diagnostic.
sourcefn should_show_explain(&self) -> bool
fn should_show_explain(&self) -> bool
Checks if should show explanations about “rustc –explain”
sourcefn supports_color(&self) -> bool
fn supports_color(&self) -> bool
Checks if we can use colors in the current output stream.
sourcefn emit_artifact_notification(&mut self, _path: &Path, _artifact_type: &str)
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. Read more
fn emit_future_breakage_report(&mut self, _diags: Vec<Diagnostic>)
sourcefn emit_unused_externs(&mut self, _lint_level: Level, _unused_externs: &[&str])
fn emit_unused_externs(&mut self, _lint_level: Level, _unused_externs: &[&str])
Emit list of unused externs
sourcefn primary_span_formatted<'a>(
&mut self,
diag: &'a Diagnostic,
fluent_args: &FluentArgs<'_>
) -> (MultiSpan, &'a [CodeSuggestion])
fn primary_span_formatted<'a>(
&mut self,
diag: &'a Diagnostic,
fluent_args: &FluentArgs<'_>
) -> (MultiSpan, &'a [CodeSuggestion])
Formats the substitutions of the primary_span Read more
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
)
sourceimpl Translate for EmitterWriter
impl Translate for EmitterWriter
sourcefn fluent_bundle(&self) -> Option<&Lrc<FluentBundle>>
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. Read moresourcefn fallback_fluent_bundle(&self) -> &FluentBundle
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. Read moresourcefn to_fluent_args<'arg>(&self, args: &[DiagnosticArg<'arg>]) -> FluentArgs<'arg>
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. Read moresourcefn translate_messages(
&self,
messages: &[(DiagnosticMessage, Style)],
args: &FluentArgs<'_>
) -> Cow<'_, str>
fn translate_messages(
&self,
messages: &[(DiagnosticMessage, Style)],
args: &FluentArgs<'_>
) -> Cow<'_, str>
Convert
DiagnosticMessage
s to a string, performing translation if necessary.sourcefn translate_message<'a>(
&'a self,
message: &'a DiagnosticMessage,
args: &'a FluentArgs<'_>
) -> Cow<'_, str>
fn translate_message<'a>(
&'a self,
message: &'a DiagnosticMessage,
args: &'a FluentArgs<'_>
) -> Cow<'_, str>
Convert a
DiagnosticMessage
to a string, performing translation if necessary.Auto Trait Implementations
impl !RefUnwindSafe for EmitterWriter
impl !Send for EmitterWriter
impl !Sync for EmitterWriter
impl Unpin for EmitterWriter
impl !UnwindSafe for EmitterWriter
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
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: 128 bytes