Struct Diagnostic 

pub struct Diagnostic {
    pub span: Option<Span>,
    pub msg: String,
}

Information attached to a diagnostic.

See the Emitter trait for general information on the error reporting strategy of formally.

See the emitter() function for how to reach the global Emitter object.

Fields

span: Option<Span>

The source span associated with this diagnostic.

msg: String

The message attached to this diagnostic.

Implementations

impl Diagnostic

pub fn new(span: Option<Span>, msg: impl Display) -> Diagnostic

Constructs a diagnostic using any Display type as the source of the message.

pub fn default_global_emitter() -> &'static dyn Emitter

Return a reference to the current default global Emitter.

This is the emitter used as the global emitter (returned by Diagnostic::emitter()) unless a call of Diagnostic::with() is ongoing in the current thread.

pub fn set_default_global_emitter(emitter: impl 'static + Send + Sync + Emitter)

Set the default global Emitter.

This is the emitter used as the global emitter (returned by Diagnostic::emitter()) unless a call of Diagnostic::with() is ongoing in the current thread.

pub fn emitter() -> &'static dyn Emitter

Return the current global Emitter.

pub fn with<E, F, R>(emitter: E, f: F) -> R

where E: 'static + Emitter, F: UnwindSafe + FnOnce() -> R,

Temporarily changes the global Emitter.

Changes the global emitter for the current thread, executes the given function, and then restores the old global emitter. If the function panics, the old emitter is restored and the panic propagated.

Trait Implementations

impl Clone for Diagnostic

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Diagnostic

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

Formats the value using the given formatter.

impl Emit for Diagnostic

fn emit(&self) -> DiagnosticEmitted

Emit the object as a diagnostic.