Struct TokenStream 

pub struct TokenStream {
    pub tokens: Vec<TokenTree>,
    pub metadata: TokenStreamMetadata,
}

An abstract stream of Cairo tokens.

This is both input and part of an output of a procedural macro.

Fields

tokens: Vec<TokenTree>

metadata: TokenStreamMetadata

Implementations

impl TokenStream

pub fn new(tokens: Vec<TokenTree>) -> Self

Create a new TokenStream from a vector of TokenTrees.

pub fn empty() -> Self

Create a new empty TokenStream.

pub fn metadata(&self) -> &TokenStreamMetadata

Get [TokenStreamMetadata] associated with this TokenStream.

The metadata struct can be used to describe the TokenStream origin.

pub fn is_empty(&self) -> bool

Check if the TokenStream is empty.

pub fn from_primitive_token_stream( stable_token_stream: impl Iterator<Item = PrimitiveToken>, ) -> Self

pub fn push_token(&mut self, token_tree: TokenTree)

Trait Implementations

impl Clone for TokenStream

fn clone(&self) -> TokenStream

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TokenStream

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

Formats the value using the given formatter.

impl Display for TokenStream

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

Formats the value using the given formatter.

impl Extend<TokenStream> for TokenStream

fn extend<T: IntoIterator<Item = TokenStream>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl Extend<TokenTree> for TokenStream

fn extend<T: IntoIterator<Item = TokenTree>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl Hash for TokenStream

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoIterator for TokenStream

type Item = TokenTree

The type of the elements being iterated over.

type IntoIter = IntoIter<TokenTree>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for TokenStream

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl ToPrimitiveTokenStream for TokenStream

type Iter = Map<IntoIter<TokenTree>, fn(TokenTree) -> PrimitiveToken>

Iterator type for PrimitiveTokens.

fn to_primitive_token_stream(&self) -> Self::Iter

Method that turns given item to a PrimitiveTokenStream iterator.

impl Eq for TokenStream

impl StructuralPartialEq for TokenStream