Struct DiagCtxt 

pub struct DiagCtxt { /* private fields */ }

A handler that deals with errors and other compiler output.

Certain errors (fatal, bug) may cause immediate exit, others log errors for later reporting.

Implementations

impl DiagCtxt

pub fn new(emitter: Box<dyn Emitter + Send>) -> DiagCtxt

Creates a new DiagCtxt with the given diagnostics emitter.

pub fn new_early() -> DiagCtxt

Creates a new DiagCtxt with a stderr emitter for emitting one-off/early fatal errors that contain no source information.

pub fn with_test_emitter(source_map: Option<Arc<SourceMap>>) -> DiagCtxt

Creates a new DiagCtxt with a test emitter.

pub fn with_stderr_emitter(source_map: Option<Arc<SourceMap>>) -> DiagCtxt

Creates a new DiagCtxt with a stderr emitter.

pub fn with_stderr_emitter_and_color( source_map: Option<Arc<SourceMap>>, color_choice: ColorChoice, ) -> DiagCtxt

Creates a new DiagCtxt with a stderr emitter and a color choice.

pub fn with_silent_emitter(fatal_note: Option<String>) -> DiagCtxt

Creates a new DiagCtxt with a silent emitter.

Fatal diagnostics will still be emitted, optionally with the given note.

pub fn with_buffer_emitter( source_map: Option<Arc<SourceMap>>, color_choice: ColorChoice, ) -> DiagCtxt

Creates a new DiagCtxt with a human emitter that emits diagnostics to a local buffer.

pub fn from_opts(opts: &Opts) -> DiagCtxt

Creates a new DiagCtxt from the given options.

This is the default DiagCtxt used by the Session if one is not provided manually. It looks at the following options:

• error_format
• color
• unstable.ui_testing
• unstable.track_diagnostics
• no_warnings
• error_format_human
• diagnostic_width

The default is human emitter to stderr.

See also DiagCtxtFlags::update_from_opts.

pub fn make_silent(&self, fatal_note: Option<String>, emit_fatal: bool)

Sets the emitter to SilentEmitter.

pub fn set_emitter( &self, emitter: Box<dyn Emitter + Send>, ) -> Box<dyn Emitter + Send>

Sets the inner emitter. Returns the previous emitter.

pub fn wrap_emitter( &self, f: impl FnOnce(Box<dyn Emitter + Send>) -> Box<dyn Emitter + Send>, )

Wraps the current emitter with the given closure.

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

Gets the source map associated with this context.

pub fn source_map_mut(&mut self) -> Option<&Arc<SourceMap>>

Gets the source map associated with this context.

pub fn with_flags(self, f: impl FnOnce(&mut DiagCtxtFlags)) -> DiagCtxt

Sets flags.

pub fn set_flags(&self, f: impl FnOnce(&mut DiagCtxtFlags))

Sets flags.

pub fn set_flags_mut(&mut self, f: impl FnOnce(&mut DiagCtxtFlags))

Sets flags.

pub fn disable_warnings(self) -> DiagCtxt

Disables emitting warnings.

pub fn track_diagnostics(&self) -> bool

Returns true if diagnostics are being tracked.

pub fn emit_diagnostic(&self, diagnostic: Diag) -> Result<(), ErrorGuaranteed>

Emits the given diagnostic with this context.

pub fn err_count(&self) -> usize

Returns the number of errors that have been emitted, including duplicates.

pub fn has_errors(&self) -> Result<(), ErrorGuaranteed>

Returns Err if any errors have been emitted.

pub fn warn_count(&self) -> usize

Returns the number of warnings that have been emitted, including duplicates.

pub fn note_count(&self) -> usize

Returns the number of notes that have been emitted, including duplicates.

pub fn emitted_diagnostics_result( &self, ) -> Option<Result<EmittedDiagnostics, EmittedDiagnostics>>

Returns the emitted diagnostics as a result. Can be empty.

Returns None if the underlying emitter is not a human buffer emitter created with with_buffer_emitter.

Results Ok if there are no errors, Err otherwise.

Examples

Print diagnostics to stdout if there are no errors, otherwise propagate with ?:

println!("{}", dcx.emitted_diagnostics_result().unwrap()?);

pub fn emitted_diagnostics(&self) -> Option<EmittedDiagnostics>

Returns the emitted diagnostics. Can be empty.

Returns None if the underlying emitter is not a human buffer emitter created with with_buffer_emitter.

pub fn emitted_errors(&self) -> Option<Result<(), EmittedDiagnostics>>

Returns Err with the printed diagnostics if any errors have been emitted.

Returns None if the underlying emitter is not a human buffer emitter created with with_buffer_emitter.

pub fn print_error_count(&self) -> Result<(), ErrorGuaranteed>

Emits a diagnostic if any warnings or errors have been emitted.

impl DiagCtxt

Diag constructors.

Note that methods returning a DiagBuilder must also marked with #[track_caller].

pub fn diag<G>( &self, level: Level, msg: impl Into<DiagMsg>, ) -> DiagBuilder<'_, G>

where G: EmissionGuarantee,

Creates a builder at the given level with the given msg.

pub fn bug(&self, msg: impl Into<DiagMsg>) -> DiagBuilder<'_, BugAbort>

Creates a builder at the Bug level with the given msg.

pub fn fatal(&self, msg: impl Into<DiagMsg>) -> DiagBuilder<'_, FatalAbort>

Creates a builder at the Fatal level with the given msg.

pub fn err(&self, msg: impl Into<DiagMsg>) -> DiagBuilder<'_, ErrorGuaranteed>

Creates a builder at the Error level with the given msg.

pub fn warn(&self, msg: impl Into<DiagMsg>) -> DiagBuilder<'_, ()>

Creates a builder at the Warning level with the given msg.

Attempting to .emit() the builder will only emit if can_emit_warnings is true.

pub fn help(&self, msg: impl Into<DiagMsg>) -> DiagBuilder<'_, ()>

Creates a builder at the Help level with the given msg.

pub fn note(&self, msg: impl Into<DiagMsg>) -> DiagBuilder<'_, ()>

Creates a builder at the Note level with the given msg.

Trait Implementations

impl Debug for DiagCtxt

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

Formats the value using the given formatter.