Struct proc_macro_error::MultiMacroErrors

pub struct MultiMacroErrors(_);

This type represents a container for multiple errors. Each error has it's own span location.

Methods

impl MultiMacroErrors

pub fn new() -> Self

Create an empty errors storage.

pub fn is_empty(&self) -> bool

Test if the storage contains no errors.

pub fn add(&mut self, err: MacroError)

Add an error to the list of errors.

pub fn add_span_msg(&mut self, span: Span, msg: String)

Shortcut for .add(MacroError::new(span, msg))

pub fn into_compile_errors(self) -> TokenStream

Convert this storage into TokenStream consisting of compile_error!(msg1); compile_error!(msg2);... sequence. Each compile_error! invocation gets the span attached to the particular message.

pub fn trigger(self) -> !

Abort the proc-macro's execution and display the errors contained.

Note:

This function aborts even no errors are present! It's very much possibly that trigger_on_error is what you really want.

pub fn trigger_on_error(self)

If this storage is not empty abort the proc-macro's execution and display the errors contained.

Trait Implementations

impl From<MultiMacroErrors> for TokenStream

fn from(errors: MultiMacroErrors) -> Self

Performs the conversion.

impl From<MultiMacroErrors> for TokenStream

fn from(errors: MultiMacroErrors) -> Self

Performs the conversion.

impl IntoIterator for MultiMacroErrors

type Item = MacroError

The type of the elements being iterated over.

type IntoIter = <Vec<MacroError> as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Deref for MultiMacroErrors

type Target = [MacroError]

The resulting type after dereferencing.

fn deref(&self) -> &[MacroError]

Dereferences the value.

impl DerefMut for MultiMacroErrors

fn deref_mut(&mut self) -> &mut [MacroError]

Mutably dereferences the value.

impl FromIterator<MacroError> for MultiMacroErrors

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

Creates a value from an iterator.