Struct proc_macro_error::single::MacroError

pub struct MacroError { /* private fields */ }

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

Implementations

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_message(&mut self, msg: String) -> String

Replace the error message with msg. Returns old message.

pub fn set_span(&mut self, 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 [span_error!] or [call_site_error!] instead.

Trait Implementations

impl AsMut<String> for MacroError

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

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<String> for MacroError

fn as_ref(&self) -> &String

Converts this type into a shared reference of the (usually inferred) input type.

impl Debug for MacroError

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

Formats the value using the given formatter.

impl Display for MacroError

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

Formats the value using the given formatter.

impl From<&str> for MacroError

fn from(msg: &str) -> Self

Converts to this type from the input type.

impl From<Error> for MacroError

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<String> for MacroError

fn from(msg: String) -> Self

Converts to this type from the input type.

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

where Self: Sized,

Convert self directly into a TokenStream object.