Struct proc_macro_utils::TokenParser

pub struct TokenParser<I: Iterator<Item = TokenTree> = IntoIter, const PEEKER_LEN: usize = 6> { /* private fields */ }

Available on crate feature parser only.

Wrapper for TokenStream::into_iter allowing not only to iterate on tokens but also to parse simple structures like types or expressions, though it does not make any claims about their correctness.

let mut token_parser = TokenParser::new(quote! {a + b, c});
assert_tokens!(token_parser.next_expression().unwrap(), { a + b });

Construction

In most cases use new() to avoid specifying the generics. To change the on-stack size of the peek-buffer use new_generic() or From::from.

Peeking

The TokenParser allows peeking an arbitrary amount of tokens using peek_n() and the token specific variants. This uses a SmallVec with its capacity specified via PEEKER_LEN (default is 6). This means peeking up to 6 tokens ahead happens without heap allocation. Token groups can need up to 3 tokens of additional space e.g. peek_n_tt_dot_dot_eq() can, with the default allocation free be called with up to 3, and peek_n_tt_plus_eq() up to 4.

Warning: Setting PEEKER_LEN = 0 means even is_empty() and peek() allocate, and a value below 3 will make some of the peek_{punctuation} allocate additionally. But do also refrain from setting PEEKER_LEN too high, as this is the stack allocation used.

Implementations

impl TokenParser

pub fn new<T, I>(value: T) -> TokenParser<I, 6>

where T: IntoIterator<Item = TokenTree, IntoIter = I>, I: Iterator<Item = TokenTree>,

Creates a new TokenParser from a TokenTree iterator.

This sets the default length for the peeker buffer. Use new_generic() to change it.

pub fn new_generic<const PEEKER_LEN: usize, T, I>( value: T ) -> TokenParser<I, PEEKER_LEN>

where T: IntoIterator<Item = TokenTree, IntoIter = I>, I: Iterator<Item = TokenTree>,

Creates a new TokenParser from a TokenTree iterator, allowing to specify the size of the peeker buffer.

See Peeking for implications.

impl<I, const PEEKER_LEN: usize> TokenParser<I, PEEKER_LEN>

where I: Iterator<Item = TokenTree>,

Some Iterator utilities

pub fn span(&mut self) -> Span

Returns span of the next token or Span::call_site().

pub fn is_empty(&mut self) -> bool

Checks if there are remaining tokens

use proc_macro_utils::TokenParser;
use quote::quote;

let mut parser = TokenParser::new(quote!(token));
assert!(!parser.is_empty());
_ = parser.next();
assert!(parser.is_empty())

pub fn peek(&mut self) -> Option<&TokenTree>

Peeks the next token without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;

let mut parser = TokenParser::new(quote!(token));
assert_tokens!(parser.peek().cloned(), { token });
_ = parser.next();
assert!(parser.peek().is_none())

pub fn peek_n(&mut self, n: usize) -> Option<&TokenTree>

Peeks the nth token without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;

let mut parser = TokenParser::new(quote!(token , third));
assert_tokens!(parser.peek_n(2).cloned(), { third });
assert_tokens!(parser.peek_n(1).cloned(), { , });
assert!(parser.peek_n(3).is_none())

pub fn next_if( &mut self, test: impl FnOnce(&TokenTree) -> bool ) -> Option<TokenTree>

Returns the next token if it fulfills the condition otherwise returns None and doesn’t advance the parser

use proc_macro_utils::{assert_tokens, TokenParser, TokenTreePunct};
use quote::quote;

let mut parser = TokenParser::new(quote!(::));
assert!(parser.next_if(TokenTreePunct::is_alone).is_none());
_ = parser.next();
assert_tokens!(parser.next_if(TokenTreePunct::is_alone), { : });

pub fn next_if_each<P: Peeker>(&mut self, tests: P) -> Option<TokenStream>

Returns the next tokens if they fulfill the conditions otherwise returns None and doesn’t advance the parser.

use proc_macro_utils::{assert_tokens, TokenParser, TokenTreePunct};
use quote::quote;

let mut parser = TokenParser::new(quote!( -->));
assert!(parser.next_if_each((TokenTreePunct::is_minus, TokenTreePunct::is_greater_than)).is_none());
_ = parser.next();
assert_tokens!(parser.next_if_each((TokenTreePunct::is_minus, TokenTreePunct::is_greater_than)).unwrap(), { -> });

pub fn next_if_each_alone<P: Peeker>(&mut self, tests: P) -> Option<TokenStream>

Returns the next tokens if they fulfill the conditions otherwise returns None and doesn’t advance the parser. If the last token is a punct it’s spacing is set to Alone.

pub fn peek_if_each<P: Peeker>(&mut self, tests: P) -> Option<TokenStream>

Returns the next tokens if they fulfill the conditions otherwise returns None, without advancing the parser

pub fn peek_n_if_each<P: Peeker>( &mut self, n: usize, tests: P ) -> Option<TokenStream>

Returns the next tokens from n if they fulfill the conditions otherwise returns None, without advancing the parser

pub fn peek_n_if_each_alone<P: Peeker>( &mut self, n: usize, tests: P ) -> Option<TokenStream>

Returns the next tokens from n if they fulfill the conditions otherwise returns None, without advancing the parser. If the last token is a punct it’s spacing is set to Alone.

pub fn next_while( &mut self, test: impl FnMut(&TokenTree) -> bool ) -> Option<TokenStream>

Returns all tokens while test evaluates to true.

Returns None if empty or test(first_token) == false

pub fn next_while_alone( &mut self, test: impl FnMut(&TokenTree) -> bool ) -> Option<TokenStream>

Returns all tokens while test evaluates to true. If the last token is a punct it’s spacing is set to Alone.

Returns None if empty or test(first_token) == false

pub fn next_until( &mut self, test: impl FnMut(&TokenTree) -> bool ) -> Option<TokenStream>

Returns all tokens while test evaluates to false.

Returns None if empty or test(first_token) == true.

pub fn next_until_alone( &mut self, test: impl FnMut(&TokenTree) -> bool ) -> Option<TokenStream>

Returns all tokens while test evaluates to false. If the last token is a punct it’s spacing is set to Alone.

Returns None if empty or test(first_token) == true.

pub fn next_n(&mut self, n: usize) -> Option<TokenStream>

Returns the next n tokens.

Returns None if the parser contains less than n tokens.

Note: This should only be used for small n ideally less than PEEKER_LEN. Otherwise, something like this would be more performant:

use proc_macro2::TokenStream;
use proc_macro_utils::{TokenParser, assert_tokens};
use quote::quote;

let mut parser = TokenParser::new(quote!(1 2 3 /*...*/ 1000 1001 1002 1003));
let n = 1000;
// This does not ensure that `next_up_to_n` contains exactly n tokens
let next_up_to_n: TokenStream = parser.by_ref().take(n).collect();
assert_tokens!(next_up_to_n, { 1 2 3 /* ...*/ 1000 });
assert_tokens!(parser, { 1001 1002 1003 });

pub fn next_n_alone(&mut self, n: usize) -> Option<TokenStream>

Returns the next n tokens. If the last token is a punct it’s spacing is set to Alone.

Returns None if the parser contains less than n tokens.

Note: This should only be used for small n ideally less than PEEKER_LEN. Otherwise, something like this would be more performant:

use proc_macro2::TokenStream;
use proc_macro_utils::{TokenParser, assert_tokens, TokenTreePunct};
use quote::quote;

let mut parser = TokenParser::new(quote!(1 2 3 /*...*/ 1000 1001 1002 1003));
let n = 1000;
// This does not ensure that `next_up_to_n` contains exactly n tokens
let mut next_up_to_n: TokenStream = parser.by_ref().take(n - 1).collect();
next_up_to_n.extend(parser.next().map(TokenTreePunct::alone));
assert_tokens!(next_up_to_n, { 1 2 3 /* ...*/ 1000 });
assert_tokens!(parser, { 1001 1002 1003 });

pub fn peek_range( &mut self, range: impl RangeBounds<usize> ) -> Option<TokenStream>

Returns the specified range of tokens.

Returns None if the parser does not contain these range tokens.

Note: This should only be used for small and close to start ranges ideally less than PEEKER_LEN. Otherwise, something like this could be more performant:

use proc_macro2::TokenStream;
use proc_macro_utils::{TokenParser, assert_tokens};
use quote::quote;

let parser = TokenParser::new(quote!(0 1 2 3 /*...*/ 1000 1001 1002 1003));
let start = 1000;
let end = 1003;
// This does not ensure that `peeked_range` contains any tokens
let peeked_range: TokenStream = parser.clone().skip(start).take(end -
start).collect();
assert_tokens!(peeked_range, { 1000 1001 1002 });
assert_tokens!(parser, { 0 1 2 3 /*...*/ 1000 1001 1002 1003 });

Panics

Panics if used without upper bound i.e. start...

pub fn peek_range_alone( &mut self, range: impl RangeBounds<usize> ) -> Option<TokenStream>

Returns the specified range of tokens. If the last token is a punct it’s spacing is set to Alone.

Returns None if the parser does not contain these range tokens.

Note: This should only be used for small and close to start ranges ideally less than PEEKER_LEN. Otherwise, something like this could be more performant:

use proc_macro2::TokenStream;
use proc_macro_utils::{assert_tokens, TokenParser, TokenTreePunct};
use quote::quote;

let parser = TokenParser::new(quote!(0 1 2 3 /*...*/ 1000 1001 1002 1003));
let start = 1000;
let end = 1003;
// This does not ensure that `peeked_range` contains any tokens
let mut cloned = parser.clone().skip(start);
let mut peeked_range: TokenStream = cloned.by_ref().take(end - start - 1).collect();
peeked_range.extend(cloned.next().map(TokenTreePunct::alone));

assert_tokens!(peeked_range, { 1000 1001 1002 });
assert_tokens!(parser, { 0 1 2 3 /*...*/ 1000 1001 1002 1003 });

Panics

Panics if used without upper bound i.e. start...

impl<I, const PEEKER_LEN: usize> TokenParser<I, PEEKER_LEN>

where I: Iterator<Item = TokenTree>,

pub fn into_token_stream(self) -> TokenStream

Collects remaining tokens back into a TokenStream

pub fn next_punctuation_group(&mut self) -> Option<TokenStream>

Returns the next group of punctuation with Punct::spacing Spacing::Joint

pub fn peek_keyword<K: ?Sized>(&mut self, keyword: &K) -> Option<&Ident>

where Ident: PartialEq<K>,

Returns the next ident if it matches the specified keyword without advancing the parser.

While this is called peek_keyword it is not restricted to rust keywords, it can be used with any ident.

let mut parser = TokenParser::new(quote!( in out ));
assert_eq!(parser.peek_keyword("in").unwrap().to_string(), "in");
assert_eq!(parser.peek_keyword("in").unwrap().to_string(), "in");
assert!(parser.peek_keyword("out").is_none());
parser.next().unwrap();
assert_eq!(parser.peek_keyword("out").unwrap().to_string(), "out");

pub fn peek_n_keyword<K: ?Sized>( &mut self, n: usize, keyword: &K ) -> Option<&Ident>

where Ident: PartialEq<K>,

Returns the nth token if it matches the specified keyword without advancing the parser.

While this is called peek_n_keyword it is not restricted to rust keywords, it can be used with any ident.

let mut parser = TokenParser::new(quote!( in out ));
assert_eq!(parser.peek_keyword("in").unwrap().to_string(), "in");
assert_eq!(parser.peek_n_keyword(1, "out").unwrap().to_string(), "out");
assert!(parser.peek_keyword("out").is_none());

pub fn next_keyword<K: ?Sized>(&mut self, keyword: &K) -> Option<Ident>

where Ident: PartialEq<K>,

Returns the next ident if it matches the specified keyword.

While this is called next_keyword it is not restricted to rust keywords, it can be used with any ident.

let mut parser = TokenParser::new(quote!( in out ));
assert_eq!(parser.next_keyword("in").unwrap().to_string(), "in");
assert!(parser.next_keyword("in").is_none());
assert_eq!(parser.next_keyword("out").unwrap().to_string(), "out");
assert!(parser.next_keyword("anything").is_none());

pub fn next_type(&mut self) -> Option<TokenStream>

“Parses” a type expression

This just means it collects all the tokens that should belong to the type, until it reaches either:

• a ;
• a , or > and all <> pairs are closed
• the end of the token stream

If the token stream is empty, or starts with ,, > or ; None is returned otherwise, Some(TokenStream) containing every token up to but excluding the terminator.

let mut tokens = TokenParser::new(quote! {A<Test, B>, remainder});
assert_tokens!(tokens.next_type().unwrap(), { A<Test, B> });
assert!(tokens.next_type().is_none());
assert_tokens!(tokens, { , remainder });

pub fn next_expression(&mut self) -> Option<TokenStream>

“Parses” an expression

This just means it collects all the tokens that should belong to the expression, until it reaches (outside a group like () or {}) either:

• a =>
• a ;
• a , outside a type
• the end of the token stream

If the token stream is empty, or starts with =>, , or ; None is returned otherwise, Some(TokenStream) containing every token up to but excluding the terminator.

let mut tokens = TokenParser::new(quote! {A + c ::<a, b>::a < b + <C as Trait<A, B>::C>::nice(), next_token});
assert_tokens!(tokens.next_expression().unwrap(), { A + c::<a, b>::a < b + <C as Trait<A, B>::C>::nice()});
assert!(tokens.next_expression().is_none());
assert_tokens!(tokens, { , next_token });

pub fn next_string(&mut self) -> Option<String>

Returns the next string literal

pub fn next_bool(&mut self) -> Option<bool>

Returns the next boolean literal

impl<I, const PEEKER_LEN: usize> TokenParser<I, PEEKER_LEN>

where I: Iterator<Item = TokenTree>,

pub fn next_group(&mut self) -> Option<Group>

Returns the next token if it is a Group.

pub fn next_ident(&mut self) -> Option<Ident>

Returns the next token if it is an Ident.

pub fn next_punct(&mut self) -> Option<Punct>

Returns the next token if it is a Punct.

pub fn next_literal(&mut self) -> Option<Literal>

Returns the next token if it is a Literal.

pub fn peek_group(&mut self) -> Option<&Group>

Returns the next token if it is a Group without advancing the parser.

pub fn peek_ident(&mut self) -> Option<&Ident>

Returns the next token if it is an Ident without advancing the parser.

pub fn peek_punct(&mut self) -> Option<&Punct>

Returns the next token if it is a Punct without advancing the parser.

pub fn peek_literal(&mut self) -> Option<&Literal>

Returns the next token if it is a Literal without advancing the parser.

pub fn peek_n_group(&mut self, n: usize) -> Option<&Group>

Returns the nth token if it is a Group without advancing the parser.

pub fn peek_n_ident(&mut self, n: usize) -> Option<&Ident>

Returns the nth token if it is an Ident without advancing the parser.

pub fn peek_n_punct(&mut self, n: usize) -> Option<&Punct>

Returns the nth token if it is a Punct without advancing the parser.

pub fn peek_n_literal(&mut self, n: usize) -> Option<&Literal>

Returns the nth token if it is a Literal without advancing the parser.

pub fn next_parenthesized(&mut self) -> Option<Group>

Returns the next token if it is a parenthesized group.

pub fn next_braced(&mut self) -> Option<Group>

Returns the next token if it is a braced group.

pub fn next_bracketed(&mut self) -> Option<Group>

Returns the next token if it is a bracketed group.

pub fn peek_parenthesized(&mut self) -> Option<&Group>

Returns the next token if it is aparenthesized group, without advancing the parser.

pub fn peek_braced(&mut self) -> Option<&Group>

Returns the next token if it is abraced group, without advancing the parser.

pub fn peek_bracketed(&mut self) -> Option<&Group>

Returns the next token if it is abracketed group, without advancing the parser.

pub fn peek_n_parenthesized(&mut self, n: usize) -> Option<&Group>

Returns the nth token if it is a parenthesized group, without advancing the parser.

pub fn peek_n_braced(&mut self, n: usize) -> Option<&Group>

Returns the nth token if it is a braced group, without advancing the parser.

pub fn peek_n_bracketed(&mut self, n: usize) -> Option<&Group>

Returns the nth token if it is a bracketed group, without advancing the parser.

impl<I, const PEEKER_LEN: usize> TokenParser<I, PEEKER_LEN>

where I: Iterator<Item = TokenTree>,

For now the naming of the tokens follow the names used in the rust reference even though they diverge from the names used at TokenTreePunct.

Note that they only match the token with correct spacing, i.e. next_plus will match + = and +a but not +=.

pub fn next_tt_plus(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree + following the same rules as macro_rule’s tt.

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(+ 1 b));
assert_tokens!(parser.next_tt_plus().unwrap(), { + });
assert_tokens!(parser, { 1 b });

pub fn peek_tt_plus(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree + following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(+ 1 b));
assert_tokens!(parser.peek_tt_plus().unwrap(), { + });

pub fn peek_n_tt_plus(&mut self, n: usize) -> Option<TokenStream>

Returns the nth token if it is a punctuation token tree + following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(b + 1));
assert_tokens!(parser.peek_n_tt_plus(1).unwrap(), { + });

pub fn next_tt_minus(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree - following the same rules as macro_rule’s tt.

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(- 1 b));
assert_tokens!(parser.next_tt_minus().unwrap(), { - });
assert_tokens!(parser, { 1 b });

pub fn peek_tt_minus(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree - following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(- 1 b));
assert_tokens!(parser.peek_tt_minus().unwrap(), { - });

pub fn peek_n_tt_minus(&mut self, n: usize) -> Option<TokenStream>

Returns the nth token if it is a punctuation token tree - following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(b - 1));
assert_tokens!(parser.peek_n_tt_minus(1).unwrap(), { - });

pub fn next_tt_star(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree * following the same rules as macro_rule’s tt.

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(* 1 b));
assert_tokens!(parser.next_tt_star().unwrap(), { * });
assert_tokens!(parser, { 1 b });

pub fn peek_tt_star(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree * following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(* 1 b));
assert_tokens!(parser.peek_tt_star().unwrap(), { * });

pub fn peek_n_tt_star(&mut self, n: usize) -> Option<TokenStream>

Returns the nth token if it is a punctuation token tree * following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(b * 1));
assert_tokens!(parser.peek_n_tt_star(1).unwrap(), { * });

pub fn next_tt_slash(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree / following the same rules as macro_rule’s tt.

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(/ 1 b));
assert_tokens!(parser.next_tt_slash().unwrap(), { / });
assert_tokens!(parser, { 1 b });

pub fn peek_tt_slash(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree / following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(/ 1 b));
assert_tokens!(parser.peek_tt_slash().unwrap(), { / });

pub fn peek_n_tt_slash(&mut self, n: usize) -> Option<TokenStream>

Returns the nth token if it is a punctuation token tree / following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(b / 1));
assert_tokens!(parser.peek_n_tt_slash(1).unwrap(), { / });

pub fn next_tt_percent(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree % following the same rules as macro_rule’s tt.

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(% 1 b));
assert_tokens!(parser.next_tt_percent().unwrap(), { % });
assert_tokens!(parser, { 1 b });

pub fn peek_tt_percent(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree % following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(% 1 b));
assert_tokens!(parser.peek_tt_percent().unwrap(), { % });

pub fn peek_n_tt_percent(&mut self, n: usize) -> Option<TokenStream>

Returns the nth token if it is a punctuation token tree % following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(b % 1));
assert_tokens!(parser.peek_n_tt_percent(1).unwrap(), { % });

pub fn next_tt_caret(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree ^ following the same rules as macro_rule’s tt.

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(^ 1 b));
assert_tokens!(parser.next_tt_caret().unwrap(), { ^ });
assert_tokens!(parser, { 1 b });

pub fn peek_tt_caret(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree ^ following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(^ 1 b));
assert_tokens!(parser.peek_tt_caret().unwrap(), { ^ });

pub fn peek_n_tt_caret(&mut self, n: usize) -> Option<TokenStream>

Returns the nth token if it is a punctuation token tree ^ following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(b ^ 1));
assert_tokens!(parser.peek_n_tt_caret(1).unwrap(), { ^ });

pub fn next_tt_not(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree ! following the same rules as macro_rule’s tt.

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(! 1 b));
assert_tokens!(parser.next_tt_not().unwrap(), { ! });
assert_tokens!(parser, { 1 b });

pub fn peek_tt_not(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree ! following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(! 1 b));
assert_tokens!(parser.peek_tt_not().unwrap(), { ! });

pub fn peek_n_tt_not(&mut self, n: usize) -> Option<TokenStream>

Returns the nth token if it is a punctuation token tree ! following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(b ! 1));
assert_tokens!(parser.peek_n_tt_not(1).unwrap(), { ! });

pub fn next_tt_and(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree & following the same rules as macro_rule’s tt.

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(& 1 b));
assert_tokens!(parser.next_tt_and().unwrap(), { & });
assert_tokens!(parser, { 1 b });

pub fn peek_tt_and(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree & following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(& 1 b));
assert_tokens!(parser.peek_tt_and().unwrap(), { & });

pub fn peek_n_tt_and(&mut self, n: usize) -> Option<TokenStream>

Returns the nth token if it is a punctuation token tree & following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(b & 1));
assert_tokens!(parser.peek_n_tt_and(1).unwrap(), { & });

pub fn next_tt_or(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree | following the same rules as macro_rule’s tt.

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(| 1 b));
assert_tokens!(parser.next_tt_or().unwrap(), { | });
assert_tokens!(parser, { 1 b });

pub fn peek_tt_or(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree | following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(| 1 b));
assert_tokens!(parser.peek_tt_or().unwrap(), { | });

pub fn peek_n_tt_or(&mut self, n: usize) -> Option<TokenStream>

Returns the nth token if it is a punctuation token tree | following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(b | 1));
assert_tokens!(parser.peek_n_tt_or(1).unwrap(), { | });

pub fn next_tt_and_and(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree && following the same rules as macro_rule’s tt.

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(&& 1 b));
assert_tokens!(parser.next_tt_and_and().unwrap(), { && });
assert_tokens!(parser, { 1 b });

pub fn peek_tt_and_and(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree && following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(&& 1 b));
assert_tokens!(parser.peek_tt_and_and().unwrap(), { && });

pub fn peek_n_tt_and_and(&mut self, n: usize) -> Option<TokenStream>

Returns the nth token if it is a punctuation token tree && following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(b && 1));
assert_tokens!(parser.peek_n_tt_and_and(1).unwrap(), { && });

pub fn next_tt_or_or(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree || following the same rules as macro_rule’s tt.

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(|| 1 b));
assert_tokens!(parser.next_tt_or_or().unwrap(), { || });
assert_tokens!(parser, { 1 b });

pub fn peek_tt_or_or(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree || following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(|| 1 b));
assert_tokens!(parser.peek_tt_or_or().unwrap(), { || });

pub fn peek_n_tt_or_or(&mut self, n: usize) -> Option<TokenStream>

Returns the nth token if it is a punctuation token tree || following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(b || 1));
assert_tokens!(parser.peek_n_tt_or_or(1).unwrap(), { || });

pub fn next_tt_shl(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree << following the same rules as macro_rule’s tt.

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(<< 1 b));
assert_tokens!(parser.next_tt_shl().unwrap(), { << });
assert_tokens!(parser, { 1 b });

pub fn peek_tt_shl(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree << following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(<< 1 b));
assert_tokens!(parser.peek_tt_shl().unwrap(), { << });

pub fn peek_n_tt_shl(&mut self, n: usize) -> Option<TokenStream>

Returns the nth token if it is a punctuation token tree << following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(b << 1));
assert_tokens!(parser.peek_n_tt_shl(1).unwrap(), { << });

pub fn next_tt_shr(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree >> following the same rules as macro_rule’s tt.

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(>> 1 b));
assert_tokens!(parser.next_tt_shr().unwrap(), { >> });
assert_tokens!(parser, { 1 b });

pub fn peek_tt_shr(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree >> following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(>> 1 b));
assert_tokens!(parser.peek_tt_shr().unwrap(), { >> });

pub fn peek_n_tt_shr(&mut self, n: usize) -> Option<TokenStream>

Returns the nth token if it is a punctuation token tree >> following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(b >> 1));
assert_tokens!(parser.peek_n_tt_shr(1).unwrap(), { >> });

pub fn next_tt_plus_eq(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree += following the same rules as macro_rule’s tt.

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(+= 1 b));
assert_tokens!(parser.next_tt_plus_eq().unwrap(), { += });
assert_tokens!(parser, { 1 b });

pub fn peek_tt_plus_eq(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree += following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(+= 1 b));
assert_tokens!(parser.peek_tt_plus_eq().unwrap(), { += });

pub fn peek_n_tt_plus_eq(&mut self, n: usize) -> Option<TokenStream>

Returns the nth token if it is a punctuation token tree += following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(b += 1));
assert_tokens!(parser.peek_n_tt_plus_eq(1).unwrap(), { += });

pub fn next_tt_minus_eq(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree -= following the same rules as macro_rule’s tt.

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(-= 1 b));
assert_tokens!(parser.next_tt_minus_eq().unwrap(), { -= });
assert_tokens!(parser, { 1 b });

pub fn peek_tt_minus_eq(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree -= following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(-= 1 b));
assert_tokens!(parser.peek_tt_minus_eq().unwrap(), { -= });

pub fn peek_n_tt_minus_eq(&mut self, n: usize) -> Option<TokenStream>

Returns the nth token if it is a punctuation token tree -= following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(b -= 1));
assert_tokens!(parser.peek_n_tt_minus_eq(1).unwrap(), { -= });

pub fn next_tt_star_eq(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree *= following the same rules as macro_rule’s tt.

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(*= 1 b));
assert_tokens!(parser.next_tt_star_eq().unwrap(), { *= });
assert_tokens!(parser, { 1 b });

pub fn peek_tt_star_eq(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree *= following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(*= 1 b));
assert_tokens!(parser.peek_tt_star_eq().unwrap(), { *= });

pub fn peek_n_tt_star_eq(&mut self, n: usize) -> Option<TokenStream>

Returns the nth token if it is a punctuation token tree *= following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(b *= 1));
assert_tokens!(parser.peek_n_tt_star_eq(1).unwrap(), { *= });

pub fn next_tt_slash_eq(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree /= following the same rules as macro_rule’s tt.

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(/= 1 b));
assert_tokens!(parser.next_tt_slash_eq().unwrap(), { /= });
assert_tokens!(parser, { 1 b });

pub fn peek_tt_slash_eq(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree /= following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(/= 1 b));
assert_tokens!(parser.peek_tt_slash_eq().unwrap(), { /= });

pub fn peek_n_tt_slash_eq(&mut self, n: usize) -> Option<TokenStream>

Returns the nth token if it is a punctuation token tree /= following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(b /= 1));
assert_tokens!(parser.peek_n_tt_slash_eq(1).unwrap(), { /= });

pub fn next_tt_percent_eq(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree %= following the same rules as macro_rule’s tt.

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(%= 1 b));
assert_tokens!(parser.next_tt_percent_eq().unwrap(), { %= });
assert_tokens!(parser, { 1 b });

pub fn peek_tt_percent_eq(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree %= following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(%= 1 b));
assert_tokens!(parser.peek_tt_percent_eq().unwrap(), { %= });

pub fn peek_n_tt_percent_eq(&mut self, n: usize) -> Option<TokenStream>

Returns the nth token if it is a punctuation token tree %= following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(b %= 1));
assert_tokens!(parser.peek_n_tt_percent_eq(1).unwrap(), { %= });

pub fn next_tt_caret_eq(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree ^= following the same rules as macro_rule’s tt.

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(^= 1 b));
assert_tokens!(parser.next_tt_caret_eq().unwrap(), { ^= });
assert_tokens!(parser, { 1 b });

pub fn peek_tt_caret_eq(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree ^= following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(^= 1 b));
assert_tokens!(parser.peek_tt_caret_eq().unwrap(), { ^= });

pub fn peek_n_tt_caret_eq(&mut self, n: usize) -> Option<TokenStream>

Returns the nth token if it is a punctuation token tree ^= following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(b ^= 1));
assert_tokens!(parser.peek_n_tt_caret_eq(1).unwrap(), { ^= });

pub fn next_tt_and_eq(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree &= following the same rules as macro_rule’s tt.

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(&= 1 b));
assert_tokens!(parser.next_tt_and_eq().unwrap(), { &= });
assert_tokens!(parser, { 1 b });

pub fn peek_tt_and_eq(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree &= following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(&= 1 b));
assert_tokens!(parser.peek_tt_and_eq().unwrap(), { &= });

pub fn peek_n_tt_and_eq(&mut self, n: usize) -> Option<TokenStream>

Returns the nth token if it is a punctuation token tree &= following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(b &= 1));
assert_tokens!(parser.peek_n_tt_and_eq(1).unwrap(), { &= });

pub fn next_tt_or_eq(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree |= following the same rules as macro_rule’s tt.

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(|= 1 b));
assert_tokens!(parser.next_tt_or_eq().unwrap(), { |= });
assert_tokens!(parser, { 1 b });

pub fn peek_tt_or_eq(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree |= following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(|= 1 b));
assert_tokens!(parser.peek_tt_or_eq().unwrap(), { |= });

pub fn peek_n_tt_or_eq(&mut self, n: usize) -> Option<TokenStream>

Returns the nth token if it is a punctuation token tree |= following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(b |= 1));
assert_tokens!(parser.peek_n_tt_or_eq(1).unwrap(), { |= });

pub fn next_tt_shl_eq(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree <<= following the same rules as macro_rule’s tt.

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(<<= 1 b));
assert_tokens!(parser.next_tt_shl_eq().unwrap(), { <<= });
assert_tokens!(parser, { 1 b });

pub fn peek_tt_shl_eq(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree <<= following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(<<= 1 b));
assert_tokens!(parser.peek_tt_shl_eq().unwrap(), { <<= });

pub fn peek_n_tt_shl_eq(&mut self, n: usize) -> Option<TokenStream>

Returns the nth token if it is a punctuation token tree <<= following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(b <<= 1));
assert_tokens!(parser.peek_n_tt_shl_eq(1).unwrap(), { <<= });

pub fn next_tt_shr_eq(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree >>= following the same rules as macro_rule’s tt.

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(>>= 1 b));
assert_tokens!(parser.next_tt_shr_eq().unwrap(), { >>= });
assert_tokens!(parser, { 1 b });

pub fn peek_tt_shr_eq(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree >>= following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(>>= 1 b));
assert_tokens!(parser.peek_tt_shr_eq().unwrap(), { >>= });

pub fn peek_n_tt_shr_eq(&mut self, n: usize) -> Option<TokenStream>

Returns the nth token if it is a punctuation token tree >>= following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(b >>= 1));
assert_tokens!(parser.peek_n_tt_shr_eq(1).unwrap(), { >>= });

pub fn next_tt_eq(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree = following the same rules as macro_rule’s tt.

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(= 1 b));
assert_tokens!(parser.next_tt_eq().unwrap(), { = });
assert_tokens!(parser, { 1 b });

pub fn peek_tt_eq(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree = following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(= 1 b));
assert_tokens!(parser.peek_tt_eq().unwrap(), { = });

pub fn peek_n_tt_eq(&mut self, n: usize) -> Option<TokenStream>

Returns the nth token if it is a punctuation token tree = following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(b = 1));
assert_tokens!(parser.peek_n_tt_eq(1).unwrap(), { = });

pub fn next_tt_eq_eq(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree == following the same rules as macro_rule’s tt.

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(== 1 b));
assert_tokens!(parser.next_tt_eq_eq().unwrap(), { == });
assert_tokens!(parser, { 1 b });

pub fn peek_tt_eq_eq(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree == following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(== 1 b));
assert_tokens!(parser.peek_tt_eq_eq().unwrap(), { == });

pub fn peek_n_tt_eq_eq(&mut self, n: usize) -> Option<TokenStream>

Returns the nth token if it is a punctuation token tree == following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(b == 1));
assert_tokens!(parser.peek_n_tt_eq_eq(1).unwrap(), { == });

pub fn next_tt_ne(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree != following the same rules as macro_rule’s tt.

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(!= 1 b));
assert_tokens!(parser.next_tt_ne().unwrap(), { != });
assert_tokens!(parser, { 1 b });

pub fn peek_tt_ne(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree != following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(!= 1 b));
assert_tokens!(parser.peek_tt_ne().unwrap(), { != });

pub fn peek_n_tt_ne(&mut self, n: usize) -> Option<TokenStream>

Returns the nth token if it is a punctuation token tree != following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(b != 1));
assert_tokens!(parser.peek_n_tt_ne(1).unwrap(), { != });

pub fn next_tt_gt(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree > following the same rules as macro_rule’s tt.

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(> 1 b));
assert_tokens!(parser.next_tt_gt().unwrap(), { > });
assert_tokens!(parser, { 1 b });

pub fn peek_tt_gt(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree > following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(> 1 b));
assert_tokens!(parser.peek_tt_gt().unwrap(), { > });

pub fn peek_n_tt_gt(&mut self, n: usize) -> Option<TokenStream>

Returns the nth token if it is a punctuation token tree > following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(b > 1));
assert_tokens!(parser.peek_n_tt_gt(1).unwrap(), { > });

pub fn next_tt_lt(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree < following the same rules as macro_rule’s tt.

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(< 1 b));
assert_tokens!(parser.next_tt_lt().unwrap(), { < });
assert_tokens!(parser, { 1 b });

pub fn peek_tt_lt(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree < following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(< 1 b));
assert_tokens!(parser.peek_tt_lt().unwrap(), { < });

pub fn peek_n_tt_lt(&mut self, n: usize) -> Option<TokenStream>

Returns the nth token if it is a punctuation token tree < following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(b < 1));
assert_tokens!(parser.peek_n_tt_lt(1).unwrap(), { < });

pub fn next_tt_ge(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree >= following the same rules as macro_rule’s tt.

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(>= 1 b));
assert_tokens!(parser.next_tt_ge().unwrap(), { >= });
assert_tokens!(parser, { 1 b });

pub fn peek_tt_ge(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree >= following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(>= 1 b));
assert_tokens!(parser.peek_tt_ge().unwrap(), { >= });

pub fn peek_n_tt_ge(&mut self, n: usize) -> Option<TokenStream>

Returns the nth token if it is a punctuation token tree >= following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(b >= 1));
assert_tokens!(parser.peek_n_tt_ge(1).unwrap(), { >= });

pub fn next_tt_le(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree <= following the same rules as macro_rule’s tt.

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(<= 1 b));
assert_tokens!(parser.next_tt_le().unwrap(), { <= });
assert_tokens!(parser, { 1 b });

pub fn peek_tt_le(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree <= following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(<= 1 b));
assert_tokens!(parser.peek_tt_le().unwrap(), { <= });

pub fn peek_n_tt_le(&mut self, n: usize) -> Option<TokenStream>

Returns the nth token if it is a punctuation token tree <= following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(b <= 1));
assert_tokens!(parser.peek_n_tt_le(1).unwrap(), { <= });

pub fn next_tt_at(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree @ following the same rules as macro_rule’s tt.

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(@ 1 b));
assert_tokens!(parser.next_tt_at().unwrap(), { @ });
assert_tokens!(parser, { 1 b });

pub fn peek_tt_at(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree @ following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(@ 1 b));
assert_tokens!(parser.peek_tt_at().unwrap(), { @ });

pub fn peek_n_tt_at(&mut self, n: usize) -> Option<TokenStream>

Returns the nth token if it is a punctuation token tree @ following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(b @ 1));
assert_tokens!(parser.peek_n_tt_at(1).unwrap(), { @ });

pub fn next_tt_dot(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree . following the same rules as macro_rule’s tt.

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(. 1 b));
assert_tokens!(parser.next_tt_dot().unwrap(), { . });
assert_tokens!(parser, { 1 b });

pub fn peek_tt_dot(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree . following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(. 1 b));
assert_tokens!(parser.peek_tt_dot().unwrap(), { . });

pub fn peek_n_tt_dot(&mut self, n: usize) -> Option<TokenStream>

Returns the nth token if it is a punctuation token tree . following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(b . 1));
assert_tokens!(parser.peek_n_tt_dot(1).unwrap(), { . });

pub fn next_tt_dot_dot(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree .. following the same rules as macro_rule’s tt.

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(.. 1 b));
assert_tokens!(parser.next_tt_dot_dot().unwrap(), { .. });
assert_tokens!(parser, { 1 b });

pub fn peek_tt_dot_dot(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree .. following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(.. 1 b));
assert_tokens!(parser.peek_tt_dot_dot().unwrap(), { .. });

pub fn peek_n_tt_dot_dot(&mut self, n: usize) -> Option<TokenStream>

Returns the nth token if it is a punctuation token tree .. following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(b .. 1));
assert_tokens!(parser.peek_n_tt_dot_dot(1).unwrap(), { .. });

pub fn next_tt_dot_dot_dot(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree ... following the same rules as macro_rule’s tt.

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(... 1 b));
assert_tokens!(parser.next_tt_dot_dot_dot().unwrap(), { ... });
assert_tokens!(parser, { 1 b });

pub fn peek_tt_dot_dot_dot(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree ... following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(... 1 b));
assert_tokens!(parser.peek_tt_dot_dot_dot().unwrap(), { ... });

pub fn peek_n_tt_dot_dot_dot(&mut self, n: usize) -> Option<TokenStream>

Returns the nth token if it is a punctuation token tree ... following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(b ... 1));
assert_tokens!(parser.peek_n_tt_dot_dot_dot(1).unwrap(), { ... });

pub fn next_tt_dot_dot_eq(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree ..= following the same rules as macro_rule’s tt.

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(..= 1 b));
assert_tokens!(parser.next_tt_dot_dot_eq().unwrap(), { ..= });
assert_tokens!(parser, { 1 b });

pub fn peek_tt_dot_dot_eq(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree ..= following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(..= 1 b));
assert_tokens!(parser.peek_tt_dot_dot_eq().unwrap(), { ..= });

pub fn peek_n_tt_dot_dot_eq(&mut self, n: usize) -> Option<TokenStream>

Returns the nth token if it is a punctuation token tree ..= following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(b ..= 1));
assert_tokens!(parser.peek_n_tt_dot_dot_eq(1).unwrap(), { ..= });

pub fn next_tt_comma(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree , following the same rules as macro_rule’s tt.

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(, 1 b));
assert_tokens!(parser.next_tt_comma().unwrap(), { , });
assert_tokens!(parser, { 1 b });

pub fn peek_tt_comma(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree , following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(, 1 b));
assert_tokens!(parser.peek_tt_comma().unwrap(), { , });

pub fn peek_n_tt_comma(&mut self, n: usize) -> Option<TokenStream>

Returns the nth token if it is a punctuation token tree , following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(b , 1));
assert_tokens!(parser.peek_n_tt_comma(1).unwrap(), { , });

pub fn next_tt_semi(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree ; following the same rules as macro_rule’s tt.

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(; 1 b));
assert_tokens!(parser.next_tt_semi().unwrap(), { ; });
assert_tokens!(parser, { 1 b });

pub fn peek_tt_semi(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree ; following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(; 1 b));
assert_tokens!(parser.peek_tt_semi().unwrap(), { ; });

pub fn peek_n_tt_semi(&mut self, n: usize) -> Option<TokenStream>

Returns the nth token if it is a punctuation token tree ; following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(b ; 1));
assert_tokens!(parser.peek_n_tt_semi(1).unwrap(), { ; });

pub fn next_tt_colon(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree : following the same rules as macro_rule’s tt.

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(: 1 b));
assert_tokens!(parser.next_tt_colon().unwrap(), { : });
assert_tokens!(parser, { 1 b });

pub fn peek_tt_colon(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree : following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(: 1 b));
assert_tokens!(parser.peek_tt_colon().unwrap(), { : });

pub fn peek_n_tt_colon(&mut self, n: usize) -> Option<TokenStream>

Returns the nth token if it is a punctuation token tree : following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(b : 1));
assert_tokens!(parser.peek_n_tt_colon(1).unwrap(), { : });

pub fn next_tt_path_sep(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree :: following the same rules as macro_rule’s tt.

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(:: 1 b));
assert_tokens!(parser.next_tt_path_sep().unwrap(), { :: });
assert_tokens!(parser, { 1 b });

pub fn peek_tt_path_sep(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree :: following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(:: 1 b));
assert_tokens!(parser.peek_tt_path_sep().unwrap(), { :: });

pub fn peek_n_tt_path_sep(&mut self, n: usize) -> Option<TokenStream>

Returns the nth token if it is a punctuation token tree :: following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(b :: 1));
assert_tokens!(parser.peek_n_tt_path_sep(1).unwrap(), { :: });

pub fn next_tt_r_arrow(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree -> following the same rules as macro_rule’s tt.

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(-> 1 b));
assert_tokens!(parser.next_tt_r_arrow().unwrap(), { -> });
assert_tokens!(parser, { 1 b });

pub fn peek_tt_r_arrow(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree -> following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(-> 1 b));
assert_tokens!(parser.peek_tt_r_arrow().unwrap(), { -> });

pub fn peek_n_tt_r_arrow(&mut self, n: usize) -> Option<TokenStream>

Returns the nth token if it is a punctuation token tree -> following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(b -> 1));
assert_tokens!(parser.peek_n_tt_r_arrow(1).unwrap(), { -> });

pub fn next_tt_fat_arrow(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree => following the same rules as macro_rule’s tt.

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(=> 1 b));
assert_tokens!(parser.next_tt_fat_arrow().unwrap(), { => });
assert_tokens!(parser, { 1 b });

pub fn peek_tt_fat_arrow(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree => following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(=> 1 b));
assert_tokens!(parser.peek_tt_fat_arrow().unwrap(), { => });

pub fn peek_n_tt_fat_arrow(&mut self, n: usize) -> Option<TokenStream>

Returns the nth token if it is a punctuation token tree => following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(b => 1));
assert_tokens!(parser.peek_n_tt_fat_arrow(1).unwrap(), { => });

pub fn next_tt_pound(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree # following the same rules as macro_rule’s tt.

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(# 1 b));
assert_tokens!(parser.next_tt_pound().unwrap(), { # });
assert_tokens!(parser, { 1 b });

pub fn peek_tt_pound(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree # following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(# 1 b));
assert_tokens!(parser.peek_tt_pound().unwrap(), { # });

pub fn peek_n_tt_pound(&mut self, n: usize) -> Option<TokenStream>

Returns the nth token if it is a punctuation token tree # following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(b # 1));
assert_tokens!(parser.peek_n_tt_pound(1).unwrap(), { # });

pub fn next_tt_dollar(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree $ following the same rules as macro_rule’s tt.

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!($ 1 b));
assert_tokens!(parser.next_tt_dollar().unwrap(), { $ });
assert_tokens!(parser, { 1 b });

pub fn peek_tt_dollar(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree $ following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!($ 1 b));
assert_tokens!(parser.peek_tt_dollar().unwrap(), { $ });

pub fn peek_n_tt_dollar(&mut self, n: usize) -> Option<TokenStream>

Returns the nth token if it is a punctuation token tree $ following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(b $ 1));
assert_tokens!(parser.peek_n_tt_dollar(1).unwrap(), { $ });

pub fn next_tt_question(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree ? following the same rules as macro_rule’s tt.

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(? 1 b));
assert_tokens!(parser.next_tt_question().unwrap(), { ? });
assert_tokens!(parser, { 1 b });

pub fn peek_tt_question(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree ? following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(? 1 b));
assert_tokens!(parser.peek_tt_question().unwrap(), { ? });

pub fn peek_n_tt_question(&mut self, n: usize) -> Option<TokenStream>

Returns the nth token if it is a punctuation token tree ? following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(b ? 1));
assert_tokens!(parser.peek_n_tt_question(1).unwrap(), { ? });

pub fn next_tt_tilde(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree ~ following the same rules as macro_rule’s tt.

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(~ 1 b));
assert_tokens!(parser.next_tt_tilde().unwrap(), { ~ });
assert_tokens!(parser, { 1 b });

pub fn peek_tt_tilde(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree ~ following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(~ 1 b));
assert_tokens!(parser.peek_tt_tilde().unwrap(), { ~ });

pub fn peek_n_tt_tilde(&mut self, n: usize) -> Option<TokenStream>

Returns the nth token if it is a punctuation token tree ~ following the same rules as macro_rule’s tt without advancing the parser

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(b ~ 1));
assert_tokens!(parser.peek_n_tt_tilde(1).unwrap(), { ~ });

pub fn next_tt(&mut self) -> Option<TokenStream>

Returns the next token tree as interpreted by the tt type in macro_rules, i.e., any literal, group, or composed punctuation.

pub fn peek_tt(&mut self) -> Option<TokenStream>

Peeks the next token tree as interpreted by the tt type in macro_rules, i.e., any literal, group, or composed punctuation.

pub fn peek_n_tt(&mut self, n: usize) -> Option<TokenStream>

Peeks the next token tree from the nth token as interpreted by the tt type in macro_rules, i.e., any literal, group, or composed punctuation.

pub fn next_macro_rules_tt(&mut self) -> Option<TokenStream>

Returns the next token if it is a punctuation token tree following the same rules as macro_rule’s tt.

use proc_macro_utils::{assert_tokens, TokenParser};
use quote::quote;
let mut parser = TokenParser::new(quote!(.. =. 1 b));
assert_tokens!(parser.next_macro_rules_tt().unwrap(), { .. });
assert_tokens!(parser.next_macro_rules_tt().unwrap(), { = });
assert_tokens!(parser, { . 1 b });

Trait Implementations

impl<I: Clone + Iterator<Item = TokenTree>, const PEEKER_LEN: usize> Clone for TokenParser<I, PEEKER_LEN>

fn clone(&self) -> TokenParser<I, PEEKER_LEN>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T, I, const PEEKER_LEN: usize> From<T> for TokenParser<I, PEEKER_LEN>

where T: IntoIterator<Item = TokenTree, IntoIter = I>, I: Iterator<Item = TokenTree>,

fn from(value: T) -> Self

Converts to this type from the input type.

impl<I, const PEEKER_LEN: usize> From<TokenParser<I, PEEKER_LEN>> for TokenStream

where I: Iterator<Item = TokenTree>,

fn from(value: TokenParser<I, PEEKER_LEN>) -> Self

Converts to this type from the input type.

impl FromStr for TokenParser

type Err = <TokenStream as FromStr>::Err

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl<I, const PEEKER_LEN: usize> Iterator for TokenParser<I, PEEKER_LEN>

where I: Iterator<Item = TokenTree>,

type Item = TokenTree

The type of the elements being iterated over.

fn next(&mut self) -> Option<Self::Item>

Advances the iterator and returns the next value.

fn next_chunk<const N: usize>( &mut self ) -> Result<[Self::Item; N], IntoIter<Self::Item, N>>

where Self: Sized,

🔬This is a nightly-only experimental API. (iter_next_chunk)

Advances the iterator and returns an array containing the next N values.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the iterator.

fn count(self) -> usize

where Self: Sized,

Consumes the iterator, counting the number of iterations and returning it.

fn last(self) -> Option<Self::Item>

where Self: Sized,

Consumes the iterator, returning the last element.

fn advance_by(&mut self, n: usize) -> Result<(), NonZero<usize>>

🔬This is a nightly-only experimental API. (iter_advance_by)

Advances the iterator by n elements.

fn nth(&mut self, n: usize) -> Option<Self::Item>

Returns the nth element of the iterator.

fn step_by(self, step: usize) -> StepBy<Self>

where Self: Sized,

Creates an iterator starting at the same point, but stepping by the given amount at each iteration.

fn chain<U>(self, other: U) -> Chain<Self, <U as IntoIterator>::IntoIter>

where Self: Sized, U: IntoIterator<Item = Self::Item>,

Takes two iterators and creates a new iterator over both in sequence.

fn zip<U>(self, other: U) -> Zip<Self, <U as IntoIterator>::IntoIter>

where Self: Sized, U: IntoIterator,

‘Zips up’ two iterators into a single iterator of pairs.

fn intersperse_with<G>(self, separator: G) -> IntersperseWith<Self, G>

where Self: Sized, G: FnMut() -> Self::Item,

🔬This is a nightly-only experimental API. (iter_intersperse)

Creates a new iterator which places an item generated by separator between adjacent items of the original iterator.

fn map<B, F>(self, f: F) -> Map<Self, F>

where Self: Sized, F: FnMut(Self::Item) -> B,

Takes a closure and creates an iterator which calls that closure on each element.

fn for_each<F>(self, f: F)

where Self: Sized, F: FnMut(Self::Item),

Calls a closure on each element of an iterator.

fn filter<P>(self, predicate: P) -> Filter<Self, P>

where Self: Sized, P: FnMut(&Self::Item) -> bool,

Creates an iterator which uses a closure to determine if an element should be yielded.

fn filter_map<B, F>(self, f: F) -> FilterMap<Self, F>

where Self: Sized, F: FnMut(Self::Item) -> Option<B>,

Creates an iterator that both filters and maps.

fn enumerate(self) -> Enumerate<Self>

where Self: Sized,

Creates an iterator which gives the current iteration count as well as the next value.

fn peekable(self) -> Peekable<Self>

where Self: Sized,

Creates an iterator which can use the peek and peek_mut methods to look at the next element of the iterator without consuming it. See their documentation for more information.

fn skip_while<P>(self, predicate: P) -> SkipWhile<Self, P>

where Self: Sized, P: FnMut(&Self::Item) -> bool,

Creates an iterator that skips elements based on a predicate.

fn take_while<P>(self, predicate: P) -> TakeWhile<Self, P>

where Self: Sized, P: FnMut(&Self::Item) -> bool,

Creates an iterator that yields elements based on a predicate.

fn map_while<B, P>(self, predicate: P) -> MapWhile<Self, P>

where Self: Sized, P: FnMut(Self::Item) -> Option<B>,

Creates an iterator that both yields elements based on a predicate and maps.

fn skip(self, n: usize) -> Skip<Self>

where Self: Sized,

Creates an iterator that skips the first n elements.

fn take(self, n: usize) -> Take<Self>

where Self: Sized,

Creates an iterator that yields the first n elements, or fewer if the underlying iterator ends sooner.

fn scan<St, B, F>(self, initial_state: St, f: F) -> Scan<Self, St, F>

where Self: Sized, F: FnMut(&mut St, Self::Item) -> Option<B>,

An iterator adapter which, like fold, holds internal state, but unlike fold, produces a new iterator.

fn flat_map<U, F>(self, f: F) -> FlatMap<Self, U, F>

where Self: Sized, U: IntoIterator, F: FnMut(Self::Item) -> U,

Creates an iterator that works like map, but flattens nested structure.

fn map_windows<F, R, const N: usize>(self, f: F) -> MapWindows<Self, F, N>

where Self: Sized, F: FnMut(&[Self::Item; N]) -> R,

🔬This is a nightly-only experimental API. (iter_map_windows)

Calls the given function f for each contiguous window of size N over self and returns an iterator over the outputs of f. Like slice::windows(), the windows during mapping overlap as well.

fn fuse(self) -> Fuse<Self>

where Self: Sized,

Creates an iterator which ends after the first None.

fn inspect<F>(self, f: F) -> Inspect<Self, F>

where Self: Sized, F: FnMut(&Self::Item),

Does something with each element of an iterator, passing the value on.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Borrows an iterator, rather than consuming it.

fn collect<B>(self) -> B

where B: FromIterator<Self::Item>, Self: Sized,

Transforms an iterator into a collection.

fn collect_into<E>(self, collection: &mut E) -> &mut E

where E: Extend<Self::Item>, Self: Sized,

🔬This is a nightly-only experimental API. (iter_collect_into)

Collects all the items from an iterator into a collection.

fn partition<B, F>(self, f: F) -> (B, B)

where Self: Sized, B: Default + Extend<Self::Item>, F: FnMut(&Self::Item) -> bool,

Consumes an iterator, creating two collections from it.

fn is_partitioned<P>(self, predicate: P) -> bool

where Self: Sized, P: FnMut(Self::Item) -> bool,

🔬This is a nightly-only experimental API. (iter_is_partitioned)

Checks if the elements of this iterator are partitioned according to the given predicate, such that all those that return true precede all those that return false.

fn try_fold<B, F, R>(&mut self, init: B, f: F) -> R

where Self: Sized, F: FnMut(B, Self::Item) -> R, R: Try<Output = B>,

An iterator method that applies a function as long as it returns successfully, producing a single, final value.

fn try_for_each<F, R>(&mut self, f: F) -> R

where Self: Sized, F: FnMut(Self::Item) -> R, R: Try<Output = ()>,

An iterator method that applies a fallible function to each item in the iterator, stopping at the first error and returning that error.

fn fold<B, F>(self, init: B, f: F) -> B

where Self: Sized, F: FnMut(B, Self::Item) -> B,

Folds every element into an accumulator by applying an operation, returning the final result.

fn reduce<F>(self, f: F) -> Option<Self::Item>

where Self: Sized, F: FnMut(Self::Item, Self::Item) -> Self::Item,

Reduces the elements to a single one, by repeatedly applying a reducing operation.

fn try_reduce<F, R>( &mut self, f: F ) -> <<R as Try>::Residual as Residual<Option<<R as Try>::Output>>>::TryType

where Self: Sized, F: FnMut(Self::Item, Self::Item) -> R, R: Try<Output = Self::Item>, <R as Try>::Residual: Residual<Option<Self::Item>>,

🔬This is a nightly-only experimental API. (iterator_try_reduce)

Reduces the elements to a single one by repeatedly applying a reducing operation. If the closure returns a failure, the failure is propagated back to the caller immediately.

fn all<F>(&mut self, f: F) -> bool

where Self: Sized, F: FnMut(Self::Item) -> bool,

Tests if every element of the iterator matches a predicate.

fn any<F>(&mut self, f: F) -> bool

where Self: Sized, F: FnMut(Self::Item) -> bool,

Tests if any element of the iterator matches a predicate.

fn find<P>(&mut self, predicate: P) -> Option<Self::Item>

where Self: Sized, P: FnMut(&Self::Item) -> bool,

Searches for an element of an iterator that satisfies a predicate.

fn find_map<B, F>(&mut self, f: F) -> Option<B>

where Self: Sized, F: FnMut(Self::Item) -> Option<B>,

Applies function to the elements of iterator and returns the first non-none result.

fn try_find<F, R>( &mut self, f: F ) -> <<R as Try>::Residual as Residual<Option<Self::Item>>>::TryType

where Self: Sized, F: FnMut(&Self::Item) -> R, R: Try<Output = bool>, <R as Try>::Residual: Residual<Option<Self::Item>>,

🔬This is a nightly-only experimental API. (try_find)

Applies function to the elements of iterator and returns the first true result or the first error.

fn position<P>(&mut self, predicate: P) -> Option<usize>

where Self: Sized, P: FnMut(Self::Item) -> bool,

Searches for an element in an iterator, returning its index.

fn max_by_key<B, F>(self, f: F) -> Option<Self::Item>

where B: Ord, Self: Sized, F: FnMut(&Self::Item) -> B,

Returns the element that gives the maximum value from the specified function.

fn max_by<F>(self, compare: F) -> Option<Self::Item>

where Self: Sized, F: FnMut(&Self::Item, &Self::Item) -> Ordering,

Returns the element that gives the maximum value with respect to the specified comparison function.

fn min_by_key<B, F>(self, f: F) -> Option<Self::Item>

where B: Ord, Self: Sized, F: FnMut(&Self::Item) -> B,

Returns the element that gives the minimum value from the specified function.

fn min_by<F>(self, compare: F) -> Option<Self::Item>

where Self: Sized, F: FnMut(&Self::Item, &Self::Item) -> Ordering,

Returns the element that gives the minimum value with respect to the specified comparison function.

fn unzip<A, B, FromA, FromB>(self) -> (FromA, FromB)

where FromA: Default + Extend<A>, FromB: Default + Extend<B>, Self: Sized + Iterator<Item = (A, B)>,

Converts an iterator of pairs into a pair of containers.

fn copied<'a, T>(self) -> Copied<Self>

where T: 'a + Copy, Self: Sized + Iterator<Item = &'a T>,

Creates an iterator which copies all of its elements.

fn cloned<'a, T>(self) -> Cloned<Self>

where T: 'a + Clone, Self: Sized + Iterator<Item = &'a T>,

Creates an iterator which clones all of its elements.

fn array_chunks<const N: usize>(self) -> ArrayChunks<Self, N>

where Self: Sized,

🔬This is a nightly-only experimental API. (iter_array_chunks)

Returns an iterator over N elements of the iterator at a time.

fn sum<S>(self) -> S

where Self: Sized, S: Sum<Self::Item>,

Sums the elements of an iterator.

fn product<P>(self) -> P

where Self: Sized, P: Product<Self::Item>,

Iterates over the entire iterator, multiplying all the elements

fn cmp_by<I, F>(self, other: I, cmp: F) -> Ordering

where Self: Sized, I: IntoIterator, F: FnMut(Self::Item, <I as IntoIterator>::Item) -> Ordering,

🔬This is a nightly-only experimental API. (iter_order_by)

Lexicographically compares the elements of this Iterator with those of another with respect to the specified comparison function.

fn partial_cmp<I>(self, other: I) -> Option<Ordering>

where I: IntoIterator, Self::Item: PartialOrd<<I as IntoIterator>::Item>, Self: Sized,

Lexicographically compares the PartialOrd elements of this Iterator with those of another. The comparison works like short-circuit evaluation, returning a result without comparing the remaining elements. As soon as an order can be determined, the evaluation stops and a result is returned.

fn partial_cmp_by<I, F>(self, other: I, partial_cmp: F) -> Option<Ordering>

where Self: Sized, I: IntoIterator, F: FnMut(Self::Item, <I as IntoIterator>::Item) -> Option<Ordering>,

🔬This is a nightly-only experimental API. (iter_order_by)

Lexicographically compares the elements of this Iterator with those of another with respect to the specified comparison function.

fn eq<I>(self, other: I) -> bool

where I: IntoIterator, Self::Item: PartialEq<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are equal to those of another.

fn eq_by<I, F>(self, other: I, eq: F) -> bool

where Self: Sized, I: IntoIterator, F: FnMut(Self::Item, <I as IntoIterator>::Item) -> bool,

🔬This is a nightly-only experimental API. (iter_order_by)

Determines if the elements of this Iterator are equal to those of another with respect to the specified equality function.

fn ne<I>(self, other: I) -> bool

where I: IntoIterator, Self::Item: PartialEq<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are not equal to those of another.

fn lt<I>(self, other: I) -> bool

where I: IntoIterator, Self::Item: PartialOrd<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are lexicographically less than those of another.

fn le<I>(self, other: I) -> bool

where I: IntoIterator, Self::Item: PartialOrd<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are lexicographically less or equal to those of another.

fn gt<I>(self, other: I) -> bool

where I: IntoIterator, Self::Item: PartialOrd<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are lexicographically greater than those of another.

fn ge<I>(self, other: I) -> bool

where I: IntoIterator, Self::Item: PartialOrd<<I as IntoIterator>::Item>, Self: Sized,

Determines if the elements of this Iterator are lexicographically greater than or equal to those of another.

fn is_sorted_by<F>(self, compare: F) -> bool

where Self: Sized, F: FnMut(&Self::Item, &Self::Item) -> bool,

🔬This is a nightly-only experimental API. (is_sorted)

Checks if the elements of this iterator are sorted using the given comparator function.

fn is_sorted_by_key<F, K>(self, f: F) -> bool

where Self: Sized, F: FnMut(Self::Item) -> K, K: PartialOrd,

🔬This is a nightly-only experimental API. (is_sorted)

Checks if the elements of this iterator are sorted using the given key extraction function.

impl<I, const PEEKER_LEN: usize> ToTokens for TokenParser<I, PEEKER_LEN>

where I: Clone + Iterator<Item = TokenTree>,

Available on crate feature quote only.

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.