Struct proc_macro_error::single::MacroError

pub struct MacroError { /* fields omitted */ }

An single error message in a proc macro with span info attached.

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 set_span(&mut self, span: Span) -> Span

Replace the span info with span. Returns old span.

pub fn span(&self) -> Span

Get the span contained.

pub fn abort(self) -> !

Abort the proc-macro's execution and show the error.

You're not supposed to use this function directly. Use abort! 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 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 Deref for MacroError

type Target = str

The resulting type after dereferencing.

fn deref(&self) -> &str

Dereferences the value.

impl DerefMut for MacroError

fn deref_mut(&mut self) -> &mut str

Mutably dereferences the value.

impl ToTokens for MacroError

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.