Struct Diagnostic

pub struct Diagnostic(pub Diagnostic<SourceId>);

Available on crate feature reporting only.

Wright’s Diagnostic type wraps one from codespan_reporting to make it compatible with things like Fragment and SourceId.

Tuple Fields

0: Diagnostic<SourceId>

Implementations

impl Diagnostic

pub fn new(severity: Severity) -> Self

Construct a new Diagnostic with the given Severity.

pub fn bug() -> Self

Construct a new Diagnostic representing a wright compiler bug.

pub fn error() -> Self

Construct a new Diagnostic representing an error.

pub fn warning() -> Self

Construct a new Diagnostic representing a warning.

pub fn note() -> Self

Construct a new Diagnostic representing a note.

pub fn help() -> Self

Construct a new Diagnostic representing a note to the user.

pub fn with_code(self, code: impl Into<String>) -> Self

Builder style function to set an error/warning code for this Diagnostic.

pub fn with_message(self, message: impl Into<String>) -> Self

Builder style function to set a message for this Diagnostic.

pub fn with_notes<I: Into<String>>( self, notes: impl IntoIterator<Item = I>, ) -> Self

Add all the notes from the given Iterator to this Diagnostic.

pub fn with_highlights( self, highlights: impl IntoIterator<Item = Highlight>, ) -> Self

Add all the Highlights from a given Iterator to this Diagnostic.

pub fn write( &self, map: &SourceMap, writer: &mut dyn WriteColor, config: &Config, ) -> Result<(), CRError>

Write this Diagnostic to a given WriteColor. This will error if any of the Highlights are not in the referenced SourceMap, or if any were constructed from invalid Fragments.

pub fn print(&self, map: &SourceMap) -> Result<(), Error>

Print this Diagnostic to the standard output. This locks the standard output until the diagnostic is printed. This uses the global get_stdout_color function to determine whether or not to use colors while printing. This uses the Config::default configuration from codespan_reporting when printing.

Trait Implementations

impl Debug for Diagnostic

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

Formats the value using the given formatter.