Struct proc_macro_error::MacroError

pub struct MacroError { /* fields omitted */ }

An error in a proc-macro. This struct preserves the given span so rustc can highlight the exact place in user code responsible for the error.

You're not supposed to use this type directly, use span_error! and call_site_error!.

Methods

impl MacroError

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

Create an error with the span and message provided.

pub fn call_site(msg: String) -> Self

A shortcut for MacroError::new(Span::call_site(), message)

pub fn into_compile_error(self) -> TokenStream

Convert this error into a TokenStream containing these tokens: compiler_error!(<message>);. All these tokens carry the span this error contains attached.

pub fn set_span(&mut self, span: Span)

Abandon the old span and replace it with the given one.

Trait Implementations

impl From<Error> for MacroError

fn from(e: Error) -> Self

Performs the conversion.

impl From<String> for MacroError

fn from(msg: String) -> Self

Performs the conversion.

impl<'_> From<&'_ str> for MacroError

fn from(msg: &str) -> Self

Performs the conversion.

impl ToString for MacroError

fn to_string(&self) -> String

Converts the given value to a String.

impl Debug for MacroError

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

Formats the value using the given formatter.