Skip to main content

MacroError

Enum MacroError 

Source
#[non_exhaustive]
pub enum MacroError { NoRules, DuplicateBinding { rule: usize, name: Symbol, }, UnboundVariable { rule: usize, name: Symbol, }, StillRepeating { rule: usize, name: Symbol, }, NoRepeatingVariable { rule: usize, }, EmptyRepetition { rule: usize, }, OptionalSeparator { rule: usize, }, }
Expand description

Why Macro::new rejected a macro definition.

Every check that can be made without an invocation is made when the macro is defined, so a macro that compiles can only fail to expand for reasons that depend on the input. Each variant names the offending rule by its index in the list passed to Macro::new; metavariable names are reported as the Symbol the definition used, which the caller resolves through its own interner.

The enum is #[non_exhaustive]: later releases may add checks.

§Examples

use macro_lang::{Macro, MacroError, Rule, Template};
use intern_lang::Interner;

let mut names = Interner::new();
let x = names.intern("x");

// The template uses `$x`, but the pattern never binds it.
let err = Macro::<char>::new(names.intern("m"), vec![Rule {
    pattern: vec![],
    template: vec![Template::Var(x)],
}]).unwrap_err();
assert_eq!(err, MacroError::UnboundVariable { rule: 0, name: x });

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.
§

NoRules

The macro has no rules, so no invocation could ever match it. Give it at least one rule.

§

DuplicateBinding

A pattern binds the same metavariable name twice, so a template use of it would be ambiguous. Rename one of the bindings.

Fields

§rule: usize

Index of the offending rule.

§name: Symbol

The name bound twice.

§

UnboundVariable

A template uses a metavariable its rule’s pattern never binds. Bind it in the pattern, or write the token literally.

Fields

§rule: usize

Index of the offending rule.

§name: Symbol

The unbound name.

§

StillRepeating

A template uses a repeating metavariable outside enough repetitions to expand it: the pattern captured it inside n repetitions, but the template uses it inside fewer. Wrap the use in a Template::Repeat.

Fields

§rule: usize

Index of the offending rule.

§name: Symbol

The metavariable used too shallowly.

§

NoRepeatingVariable

A template repetition contains no metavariable that repeats at its depth, so there is no way to know how many times to write it. Use a repeating metavariable inside it, or remove the repetition.

Fields

§rule: usize

Index of the offending rule.

§

EmptyRepetition

A pattern repetition can match without consuming anything, so it could repeat forever. Give its body at least one token, group, or binding that must be present.

Fields

§rule: usize

Index of the offending rule.

§

OptionalSeparator

A pattern repetition uses Kleene::ZeroOrOne together with a separator. An optional element never repeats, so the separator could never appear. Remove the separator.

Fields

§rule: usize

Index of the offending rule.

Trait Implementations§

Source§

impl Clone for MacroError

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 MacroError

Source§

impl Debug for MacroError

Source§

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

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

impl Display for MacroError

Source§

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

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

impl Eq for MacroError

Source§

impl Error for MacroError

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 MacroError

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 MacroError

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 MacroError

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.