Struct Report 

pub struct Report { /* private fields */ }

A collection of errors can may built up over the course of an operation.

To construct a report, see Context::new_report(). The context that constructs a report is the only one whose SpanIds should be passed into it; doing otherwise will result in unspecified output (or probably a panic).

Implementations

impl Report

pub fn builtins<'a>(&'a self, spec: &'a Spec) -> Builtins<'_>

Returns a wrapper for accessing commonly-used, built-in message types.

See Builtins.

pub fn error(&self, message: impl Display) -> Diagnostic

Adds a new error to this report.

The returned Diagnostic object can be used to add spans, notes, and remarks, to generate a richer diagnostic.

pub fn warn(&self, message: impl Display) -> Diagnostic

Adds a new warning to this report.

The returned Diagnostic object can be used to add spans, notes, and remarks, to generate a richer diagnostic.

pub fn note(&self, message: impl Display) -> Diagnostic

Adds a new top-level note to this report.

The returned Diagnostic object can be used to add spans, notes, and remarks, to generate a richer diagnostic.

pub fn fatal<T>(&self) -> Result<T, Fatal>

Returns a Fatal regardless of whether this report contains any errors.

pub fn fatal_or<T>(&self, ok: T) -> Result<T, Fatal>

If this report contains any errors, returns Err(Fatal); otherwise, it returns Ok(ok).

This is a useful function for completing some operation that could have generated error diagnostics.

See Fatal.

pub fn collate(&self)

Collates all of the “unsorted diagnostics” into the “sorted diagnostics”, sorting them by thread id.

This ensures that all diagnostics coming from a particular thread are together.

pub fn write_out(&self, sink: impl Write) -> Result<()>

Writes out the contents of this diagnostic to sink.