Struct proc_macro_error::single::MacroError

pub struct MacroError { /* fields omitted */ }

An single 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.

There are From<[MacroError]> for proc_macro/proc_macro2::TokenStream implementations so you can use error.into() instead of this method.

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

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

pub fn span(&self) -> Span

Get the span contained.

pub fn trigger(self) -> !

Trigger single error, aborting the proc-macro's execution.

You're not supposed to use this function directly. Use span_error! or call_site_error! instead.

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 From<MacroError> for TokenStream

fn from(err: MacroError) -> Self

Performs the conversion.

impl From<MacroError> for TokenStream

fn from(err: MacroError) -> Self

Performs the conversion.

impl AsMut<String> for MacroError

fn as_mut(&mut self) -> &mut String

Performs the conversion.

impl AsRef<String> for MacroError

fn as_ref(&self) -> &String

Performs the conversion.

impl Display for MacroError

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

Formats the value using the given formatter.

impl Debug for MacroError

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

Formats the value using the given formatter.

impl FromIterator<MacroError> for MultiMacroErrors

fn from_iter<I>(iter: I) -> Self where
    I: IntoIterator<Item = MacroError>, 

Creates a value from an iterator.