Struct TokenStream

pub struct TokenStream<T: Token>(/* private fields */);

A stream of tokens. Tokens in this case are either PreTokens or PostTokens. Note that, unless you are working on formatting specifically, you should never need to work with PostTokens.

Implementations

impl TokenStream<PreToken>

pub fn blank_line(&mut self)

Inserts a blank line token to the stream if the stream does not already end with a blank line. This will replace any Trivia::BlankLine tokens with PreToken::BlankLine.

pub fn end_line(&mut self)

Inserts an end of line token to the stream if the stream does not already end with an end of line token.

This will also trim any trailing PreToken::WordEnd tokens.

pub fn end_word(&mut self)

Inserts a word end token to the stream if the stream does not already end with a word end token.

pub fn increment_indent(&mut self)

Inserts an indent start token to the stream. This will also end the current line.

pub fn decrement_indent(&mut self)

Inserts an indent end token to the stream. This will also end the current line.

pub fn allow_blank_lines(&mut self)

Inserts a trivial blank lines “always allowed” context change.

pub fn ignore_trailing_blank_lines(&mut self)

Inserts a trivial blank lines “not allowed after comments” context change.

pub fn push_ast_token(&mut self, token: &Token)

Pushes an AST token into the stream.

This will also push any preceding or inline trivia into the stream. Any token may have preceding or inline trivia, unless that token is itself trivia (i.e. trivia cannot have trivia).

Panics

This will panic if the provided token is trivia.

pub fn push_literal_in_place_of_token( &mut self, token: &Token, replacement: String, )

Pushes a literal string into the stream in place of an AST token.

This will insert any trivia that would have been inserted with the AST token.

Panics

This will panic if the provided token is trivia.

pub fn push_literal(&mut self, value: String, kind: SyntaxKind)

Pushes a literal string into the stream.

This will not insert any trivia.

pub fn last_literal_kind(&self) -> Option<SyntaxKind>

Returns the kind of the last literal token in the stream.

impl<T: Token> TokenStream<T>

pub fn push(&mut self, token: T)

Pushes a token into the stream.

pub fn trim_end(&mut self, token: &T)

Removes any number of tokens at the end of the stream.

pub fn trim_while<F: Fn(&T) -> bool>(&mut self, predicate: F)

Removes any number of tokens at the end of the stream.

pub fn is_empty(&self) -> bool

Returns whether the stream is empty.

pub fn iter(&self) -> Iter<'_, T>

Returns an iterator over the tokens in the stream.

pub fn clear(&mut self)

Clears the stream.

pub fn extend(&mut self, other: Self)

Extends the stream with the tokens from another stream.

Trait Implementations

impl<T: Clone + Token> Clone for TokenStream<T>

fn clone(&self) -> TokenStream<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Token> Debug for TokenStream<T>

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

Formats the value using the given formatter.

impl<T: Token> Default for TokenStream<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: Token> IntoIterator for TokenStream<T>

type IntoIter = IntoIter<<TokenStream<T> as IntoIterator>::Item>

Which kind of iterator are we turning this into?

type Item = T

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.