Struct Errors

pub struct Errors { /* private fields */ }

A wrapper for a list of errors. Can be empty.

Implementations

impl Errors

pub const fn new() -> Self

Creates a new empty error list.

pub fn is_empty(&self) -> bool

Checks if the list contains any errors.

pub fn clear(&self)

Reset the list to an empty state.

pub fn push<T: Display>(&self, span: Span, message: T)

Pushes one error onto the list. This function is a wrapper around syn::Error::new.

pub fn push_call_site<T: Display>(&self, message: T)

Pushes one error onto the list, setting the error’s span to Span::call_site().

pub fn push_spanned<T, U>(&self, tokens: T, message: U)

where T: ToTokens, U: Display,

Pushes one error onto the list spanning the given syntax tree node. This function is a wrapper around syn::Error::new_spanned.

pub fn push_syn(&self, error: Error)

Pushes one previously constructed Error onto the list.

pub fn push_result<T>(&self, result: Result<T>) -> Option<T>

Pushes an error onto the list from a Result.

If result is Err, pushes the error and returns None. If result is Ok, returns Some(T).

pub fn extend<T: IntoIterator<Item = Error>>(&self, iter: T)

Appends all errors from iter into this list.

pub fn into_result<T>(self, value: T) -> Result<T>

Returns Err if the list has errors, or Ok(value) if the list is empty.

If the list has any errors, returns Err containing one Error with all of the errors combined using Error::combine.

pub fn check(self) -> Result<()>

Checks if the error list is empty.

If the list has any errors, returns Err containing one Error with all of the errors combined using Error::combine. Otherwise, returns Ok.

pub fn unwrap_err(self) -> Error

Returns the inner if the error list has errors.

Panics

Panics if the error list is empty.

pub fn bail<T>(self) -> Result<T>

Returns a new Err if the error list has errors.

Panics

Panics if the error list is empty.

pub fn into_compile_error(self) -> Option<TokenStream>

Converts the error list into a token stream containing std::compile_error invocations.

The errors are generated with Error::into_compile_error.

Returns None if the list is empty.

pub fn into_compile_errors(self) -> impl IntoIterator<Item = TokenStream>

Returns an iterator of token streams containing std::compile_error invocations.

Each token stream will contain one invocation. The errors are generated with Error::into_compile_error.

pub fn output_with<Q: ToTokens>(self, item: Q) -> TokenStream

Creates a token stream containing the current set of errors and item.

Trait Implementations

impl Clone for Errors

fn clone(&self) -> Errors

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Errors

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

Formats the value using the given formatter.

impl Default for Errors

fn default() -> Errors

Returns the “default value” for a type.

impl From<Error> for Errors

fn from(err: Error) -> Self

Converts to this type from the input type.

impl FromIterator<Error> for Errors

fn from_iter<T: IntoIterator<Item = Error>>(iter: T) -> Self

Creates a value from an iterator.

impl IntoIterator for Errors

type Item = Error

The type of the elements being iterated over.

type IntoIter = ErrorsIntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl ToTokens for Errors

fn to_tokens(&self, tokens: &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.