# Struct rustc_ast::tokenstream::TokenStream

source ·

    pub struct TokenStream(pub(crate) Lrc<Vec<TokenTree>>);

Expand description

A `TokenStream` is an abstract sequence of tokens, organized into `TokenTree`s.

The goal is for procedural macros to work with `TokenStream`s and `TokenTree`s instead of a representation of the abstract syntax tree. Today’s `TokenTree`s can still contain AST via `token::Interpolated` for backwards compatibility.

## Tuple Fields§

§`0: Lrc<Vec<TokenTree>>`

## Implementations§

source§

### impl TokenStream

source

#### pub fn add_comma(&self) -> Option<(TokenStream, Span)>

Given a `TokenStream` with a `Stream` of only two arguments, return a new `TokenStream` separating the two arguments with a comma for diagnostic suggestions.

source§

### impl TokenStream

source

#### pub fn new(streams: Vec<TokenTree>) -> TokenStream

source

#### pub fn is_empty(&self) -> bool

source

#### pub fn len(&self) -> usize

source

#### pub fn trees(&self) -> RefTokenTreeCursor<'_> ⓘ

source

#### pub fn into_trees(self) -> TokenTreeCursor

source

#### pub fn eq_unspanned(&self, other: &TokenStream) -> bool

Compares two `TokenStream`s, checking equality without regarding span information.

source

#### pub fn token_alone(kind: TokenKind, span: Span) -> TokenStream

Create a token stream containing a single token with alone spacing. The spacing used for the final token in a constructed stream doesn’t matter because it’s never used. In practice we arbitrarily use `Spacing::Alone`.

source

#### pub fn from_ast( node: &(impl HasAttrs + HasSpan + HasTokens + Debug) ) -> TokenStream

source

#### pub fn from_nonterminal_ast(nt: &Nonterminal) -> TokenStream

source

#### fn flatten_token(token: &Token, spacing: Spacing) -> TokenTree

source

#### fn flatten_token_tree(tree: &TokenTree) -> TokenTree

source

#### pub fn flattened(&self) -> TokenStream

source

#### fn try_glue_to_last(vec: &mut Vec<TokenTree>, tt: &TokenTree) -> bool

source

#### pub fn push_tree(&mut self, tt: TokenTree)

Push `tt` onto the end of the stream, possibly gluing it to the last token. Uses `make_mut` to maximize efficiency.

source

#### pub fn push_stream(&mut self, stream: TokenStream)

Push `stream` onto the end of the stream, possibly gluing the first token tree to the last token. (No other token trees will be glued.) Uses `make_mut` to maximize efficiency.

source

#### pub fn chunks(&self, chunk_size: usize) -> Chunks<'_, TokenTree>

source

#### pub fn desugar_doc_comments(&mut self)

Desugar doc comments like `/// foo` in the stream into `#[doc = r"foo"]`. Modifies the `TokenStream` via `Lrc::make_mut`, but as little as possible.

## Trait Implementations§

source§

### impl Clone for TokenStream

source§

#### fn clone(&self) -> TokenStream

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from `source`. Read more
source§

### impl Debug for TokenStream

source§

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

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

### impl<__D: SpanDecoder> Decodable<__D> for TokenStream

source§

#### fn decode(__decoder: &mut __D) -> Self

source§

### impl Default for TokenStream

source§

#### fn default() -> TokenStream

Returns the “default value” for a type. Read more
source§

### impl<__E: SpanEncoder> Encodable<__E> for TokenStream

source§

#### fn encode(&self, __encoder: &mut __E)

source§

### impl FromIterator<TokenTree> for TokenStream

source§

#### fn from_iter<I: IntoIterator<Item = TokenTree>>(iter: I) -> Self

Creates a value from an iterator. Read more
source§

### impl<CTX> HashStable<CTX> for TokenStream
where CTX: HashStableContext,

source§

#### fn hash_stable(&self, hcx: &mut CTX, hasher: &mut StableHasher)

source§

### impl PartialEq for TokenStream

source§

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

This method tests for `self` and `other` values to be equal, and is used by `==`.
1.0.0 · source§

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

This method tests for `!=`. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

### impl Eq for TokenStream

## Auto Trait Implementations§

§

### impl DynSend for TokenStream

§

### impl DynSync for TokenStream

§

### impl Freeze for TokenStream

§

### impl !RefUnwindSafe for TokenStream

§

### impl !Send for TokenStream

§

### impl !Sync for TokenStream

§

### impl Unpin for TokenStream

§

### impl !UnwindSafe for TokenStream

## Blanket Implementations§

source§

### impl<T> Aligned for T

source§

#### const ALIGN: Alignment = _

Alignment of `Self`.
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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

#### fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
source§

### impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

#### fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
source§

### impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

#### fn equivalent(&self, key: &K) -> bool

Compare self to `key` and return `true` if they are equal.
source§

### impl<T> From<T> for T

source§

#### fn from(t: T) -> T

Returns the argument unchanged.

source§

### impl<T> Instrument for T

source§

#### fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided `Span`, returning an `Instrumented` wrapper. Read more
source§

#### fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current `Span`, returning an `Instrumented` wrapper. Read more
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> Pointable for T

source§

#### const ALIGN: usize = _

The alignment of pointer.
§

#### type Init = T

The type for initializers.
source§

#### unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
source§

#### unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
source§

#### unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
source§

#### unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

### impl<T> Same for T

§

#### type Output = T

Should always be `Self`
source§

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

§

#### 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, U> TryFrom<U> for T
where U: Into<T>,

§

#### type Error = Infallible

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

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

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

§

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

### impl<T> WithSubscriber for T

source§

#### fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided `Subscriber` to this type, returning a `WithDispatch` wrapper. Read more
source§

#### fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default `Subscriber` to this type, returning a `WithDispatch` wrapper. Read more
source§

### impl<'a, T> Captures<'a> for T
where T: ?Sized,

## Layout§

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain `repr(...)` attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 8 bytes