Skip to main content

ExpandError

Enum ExpandError 

Source
#[non_exhaustive]
pub enum ExpandError { NoMatch { span: Span, }, Ambiguous { rule: usize, }, RepetitionMismatch { rule: usize, }, RecursionLimit { limit: u32, }, Budget(Limit), ContextOverflow, }
Expand description

Why Expander::expand could not expand an invocation.

A failed expansion leaves the expander exactly as it was: no contexts are minted and no expansion is recorded. The enum is #[non_exhaustive].

§Examples

use macro_lang::{Context, ExpandError, Expander, Macro, Pattern, Rule};
use intern_lang::Interner;
use token_lang::Span;
use macro_lang::Tree;

let mut names = Interner::new();
// A macro that accepts exactly `a`.
let mac = Macro::new(names.intern("only_a"), vec![Rule {
    pattern: vec![Pattern::Token('a')],
    template: vec![],
}])?;

let mut expander = Expander::new();
let input = [Tree::token('b', Span::new(9, 10))];
let err = expander.expand(&mac, &input, Span::new(0, 11), Context::ROOT).unwrap_err();
// The error points at the token no rule could get past.
assert_eq!(err, ExpandError::NoMatch { span: Span::new(9, 10) });

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

NoMatch

No rule matched the invocation.

span locates the furthest point any rule reached before failing: the token no rule could accept, or an empty span at the end of the input if every rule wanted more. Report it as “no rules expected this token”.

Fields

§span: Span

Where matching got stuck.

§

Ambiguous

A rule matched the invocation in more than one way, so the captures are ambiguous — for example $($a:tt)* $($b:tt)* cannot tell where a ends. Rules are tried in order, and an ambiguous rule stops the search rather than falling through. Make the rule’s repetitions unambiguous, typically with a separator or a literal token between them.

Fields

§rule: usize

Index of the ambiguous rule.

§

RepetitionMismatch

A template repetition uses metavariables that captured different numbers of repetitions, so they cannot be expanded in lockstep. Match them in the same pattern repetition, or expand them in separate template repetitions.

Fields

§rule: usize

Index of the rule that matched.

§

RecursionLimit

The invocation is nested deeper than the expander’s recursion limit (Budget::max_depth) — almost always a macro that expands to an invocation of itself without a base case. Fix the macro, or raise the limit with Expander::with_limit.

Fields

§limit: u32

The limit that was exceeded.

§

Budget(Limit)

The expander has used up part of its Budget: it has already performed max_expansions expansions, or this one would take the number of tokens written past max_tokens. Almost always a macro whose output grows without bound, such as one that doubles its argument on every round, or one that expands into several calls of itself. Fix the macro, or raise the budget with Expander::set_budget. A long-lived host should call Expander::reset_usage once per unit of work, or legitimate input eventually exhausts the budget.

Added in 1.1.0.

§

ContextOverflow

The expander has minted all u32::MAX hygiene contexts it can address. Contexts are never reclaimed, so this takes billions of expansions; start a fresh Expander.

Trait Implementations§

Source§

impl Clone for ExpandError

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for ExpandError

Source§

impl Debug for ExpandError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for ExpandError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for ExpandError

Source§

impl Error for ExpandError

1.30.0 · Source§

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type-based access to context intended for error reports. Read more
Source§

impl Hash for ExpandError

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for ExpandError

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for ExpandError

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.