Struct flycatcher_diagnostic::DiagnosticEmitter

pub struct DiagnosticEmitter<'a> {
    pub config: Config,
    pub filename: &'a str,
    pub source: &'a str,
}

A tool for emitting diagnostic messages to the terminal.

Fields

config: Config

The configuration used for displaying diagnostic messages. The default is similar to the way RustC displays diagnostic messages.

filename: &'a str

The name of the file that the diagnostic messages should say. If you don’t know what to use here, just use @anonymous.

source: &'a str

The source of the file, used by diagnostic messages to provide a snippet of the offending code.

Implementations

impl<'a> DiagnosticEmitter<'a>

pub fn new(filename: &'a str, source: &'a str) -> Self

Allocates a new DiagnosticEmitter that will emit diagnostic messages with the file path provided.

Arguments

• filename: This is the filename that will be displayed in the diagnostic messages when they are emitted to the console.
• source: The contents of the file that the diagnostics are for.

pub fn emit_diagnostic(&self, diagnostic: Diagnostic<()>)

Emits a single diagnostic message to the console.

Arguments

• diagnostic: The diagnostic message to display.

pub fn emit(&self, diagnostics: Vec<Diagnostic<()>>)

Emits a list of diagnostics to the terminal.

Arguments

• diagnostics: The vector of diagnostics to log to the console.