Struct proc_macro_error::Diagnostic

pub struct Diagnostic { /* private fields */ }

Represents a single diagnostic message

Implementations

impl Diagnostic

pub fn new(level: Level, message: String) -> Self

Create a new diagnostic message that points to Span::call_site()

pub fn spanned(span: Span, level: Level, message: String) -> Self

Create a new diagnostic message that points to the span

pub fn span_error(self, span: Span, msg: String) -> Self

Add another error message to self such that it will be emitted right after the main message.

pub fn span_help(self, span: Span, msg: String) -> Self

Attach a “help” note to your main message, the note will have it’s own span on nightly.

Span

The span is ignored on stable, the note effectively inherits its parent’s (main message) span

pub fn help(self, msg: String) -> Self

Attach a “help” note to your main message.

pub fn span_note(self, span: Span, msg: String) -> Self

Attach a note to your main message, the note will have it’s own span on nightly.

Span

The span is ignored on stable, the note effectively inherits its parent’s (main message) span

pub fn note(self, msg: String) -> Self

Attach a note to your main message

pub fn message(&self) -> &str

The message of main warning/error (no notes attached)

pub fn abort(self) -> !

Abort the proc-macro’s execution and display the diagnostic.

Warnings

Warnings are not emitted on stable and beta, but this function will abort anyway.

pub fn emit(self)

Display the diagnostic while not aborting macro execution.

Warnings

Warnings are ignored on stable/beta

Trait Implementations

impl Debug for Diagnostic

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

Formats the value using the given formatter.

impl DiagnosticExt for Diagnostic

fn spanned_range(span_range: SpanRange, level: Level, message: String) -> Self

Create a new diagnostic message that points to the span_range.

fn span_range_error(self, span_range: SpanRange, msg: String) -> Self

Add another error message to self such that it will be emitted right after the main message.

fn span_range_help(self, span_range: SpanRange, msg: String) -> Self

Attach a “help” note to your main message, the note will have it’s own span on nightly.

fn span_range_note(self, span_range: SpanRange, msg: String) -> Self

Attach a note to your main message, the note will have it’s own span on nightly.

impl From<Error> for Diagnostic

fn from(err: Error) -> Self

Performs the conversion.

impl ToTokens for Diagnostic

fn to_tokens(&self, ts: &mut TokenStream)

Write self to the given TokenStream.

fn to_token_stream(&self) -> TokenStream

Convert self directly into a TokenStream object.

fn into_token_stream(self) -> TokenStream

Convert self directly into a TokenStream object.