Struct Diagnostic

pub struct Diagnostic { /* private fields */ }

A type representing a diagnostic that is ready to be written to output.

Implementations

impl Diagnostic

pub fn write<W>(&self, cache: &SourceCache, w: W) -> Result<(), Error>

where W: Write,

Write this diagnostic to an implementor of Write.

If using the concolor feature, this method assumes that the output is ultimately going to be printed to stderr. If you are printing to stdout, use the write_for_stdout method instead.

If you wish to write to stderr or stdout, you can do so via Diagnostic::eprint or Diagnostic::print respectively.

pub fn write_for_stdout<W>( &self, cache: &SourceCache, w: W, ) -> Result<(), Error>

where W: Write,

Write this diagnostic to an implementor of Write, assuming that the output is ultimately going to be printed to stdout.

impl Diagnostic

pub fn new<R>(kind: R) -> DiagnosticBuilder

where R: ReportLevel + 'static,

Begin building a new Diagnostic.

impl Diagnostic

pub fn eprint(&self, cache: &SourceCache) -> Result<(), Error>

Write this diagnostic out to stderr.

pub fn print(&self, cache: &SourceCache) -> Result<(), Error>

Write this diagnostic out to stdout.

In most cases, Diagnostic::eprint is the ‘more correct’ function to use.

Trait Implementations

impl Debug for Diagnostic

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

Formats the value using the given formatter.