Skip to main content

Limit

Enum Limit 

Source
#[non_exhaustive]
pub enum Limit { Expansions { max: usize, }, Tokens { max: usize, }, }
Expand description

Which part of a Budget an expansion ran out of, reported by ExpandError::Budget.

Depth is not listed: exceeding Budget::max_depth keeps reporting ExpandError::RecursionLimit, as it did before budgets existed. The enum is #[non_exhaustive] so that further limits can be added in a minor release.

§Examples

use macro_lang::{Budget, Context, ExpandError, Expander, Limit, Macro, Rule, Template};
use intern_lang::Interner;
use token_lang::Span;

let mut names = Interner::new();
// three!() => a b c
let three = Macro::new(names.intern("three"), vec![Rule {
    pattern: vec![],
    template: "abc".chars().map(|c| Template::token(c, Span::new(0, 1))).collect(),
}])?;

let mut expander = Expander::with_budget(Budget::DEFAULT.with_max_tokens(5));
assert!(expander.expand(&three, &[], Span::new(0, 1), Context::ROOT).is_ok());
// Three more tokens would make six, one more than the budget allows.
assert_eq!(
    expander.expand(&three, &[], Span::new(0, 1), Context::ROOT),
    Err(ExpandError::Budget(Limit::Tokens { max: 5 })),
);

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

Expansions

Budget::max_expansions expansions have already been performed.

Fields

§max: usize

The limit that was reached.

§

Tokens

The expansion would write more than Budget::max_tokens tokens in total.

Fields

§max: usize

The limit that would have been exceeded.

Trait Implementations§

Source§

impl Clone for Limit

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 Limit

Source§

impl Debug for Limit

Source§

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

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

impl Display for Limit

Source§

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

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

impl Eq for Limit

Source§

impl Hash for Limit

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 Limit

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 Limit

Auto Trait Implementations§

§

impl Forget for Limit

§

impl Freeze for Limit

§

impl Move for Limit

§

impl RefUnwindSafe for Limit

§

impl Send for Limit

§

impl Sync for Limit

§

impl Unpin for Limit

§

impl UnsafeUnpin for Limit

§

impl UnwindSafe for Limit

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.