Struct proc_macro::TokenStream

pub struct TokenStream(_);

此 crate 提供的主要类型，表示 tokens 的抽象流，或更具体地说，表示 token 树的序列。 该类型提供用于迭代这些 token 树的接口，并且相反，将大量 token 树收集到一个流中。

这是 #[proc_macro]，#[proc_macro_attribute] 和 #[proc_macro_derive] 定义的输入和输出。

Implementations

impl TokenStream

pub fn new() -> TokenStream

返回不包含 token 树的空 TokenStream。

pub fn is_empty(&self) -> bool

检查此 TokenStream 是否为空。

pub fn expand_expr(&self) -> Result<TokenStream, ExpandError>

🔬This is a nightly-only experimental API. (proc_macro_expand #90765)

将此 TokenStream 解析为表达式并尝试扩展其中的任何宏。返回扩展的 TokenStream。

目前只有扩展到字面量的表达式会成功，尽管这在 future 中可能会有所放松。

NOTE: 在错误情况下，expand_expr 可能会保留未扩展的宏、报告错误、编译失败或者返回 Err(..)。 任何错误条件的具体行为，以及哪些条件被视为错误，是未指定的，可能会在 future 中发生变化。

Trait Implementations

impl Clone for TokenStream

fn clone(&self) -> TokenStream

返回值的副本。

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

从 source 执行复制分配。

impl Debug for TokenStream

以方便调试的形式打印 token。

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

使用给定的格式化程序格式化该值。

impl Default for TokenStream

fn default() -> Self

返回类型的 “默认值”。

impl Display for TokenStream

将 token 流打印为应该无损转换为相同 token 流 (模数跨度) 的字符串，但可能带有 Delimiter::None 分隔符和负数字字面量的 TokenTree::Group 除外。

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

使用给定的格式化程序格式化该值。

impl Extend<TokenStream> for TokenStream

fn extend<I: IntoIterator<Item = TokenStream>>(&mut self, streams: I)

使用迭代器的内容扩展集合。

fn extend_one(&mut self, item: A)

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

用一个元素扩展一个集合。

fn extend_reserve(&mut self, additional: usize)

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

在集合中为给定数量的附加元素保留容量。

impl Extend<TokenTree> for TokenStream

fn extend<I: IntoIterator<Item = TokenTree>>(&mut self, trees: I)

使用迭代器的内容扩展集合。

fn extend_one(&mut self, item: A)

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

用一个元素扩展一个集合。

fn extend_reserve(&mut self, additional: usize)

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

在集合中为给定数量的附加元素保留容量。

impl From<TokenTree> for TokenStream

创建包含单个 token 树的 token 流。

fn from(tree: TokenTree) -> TokenStream

从输入类型转换为此类型。

impl FromIterator<TokenStream> for TokenStream

对 token 流的 “flattening” 操作将来自多个 token 流的 token 树收集到单个流中。

fn from_iter<I: IntoIterator<Item = TokenStream>>(streams: I) -> Self

从迭代器创建一个值。

impl FromIterator<TokenTree> for TokenStream

将多个 token 树收集到单个流中。

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

从迭代器创建一个值。

impl FromStr for TokenStream

尝试将字符串拆分为 tokens 并将那些 tokens 解析为 token 流。 可能由于多种原因而失败，例如，如果字符串包含不平衡的定界符或该语言中不存在的字符。

解析的流中的所有 tokens 都获得 Span::call_site() 跨度。

NOTE: 某些错误可能导致 panics 而不是返回 LexError。我们保留稍后将这些错误更改为 LexError 的权利。

type Err = LexError

可以从解析中返回的相关错误。

fn from_str(src: &str) -> Result<TokenStream, LexError>

解析字符串 s 以返回此类型的值。

impl IntoIterator for TokenStream

type Item = TokenTree

被迭代的元素的类型。

type IntoIter = IntoIter

我们将其变成哪种迭代器？

fn into_iter(self) -> IntoIter

从一个值创建一个迭代器。

impl ToString for TokenStream

fn to_string(&self) -> String

将给定值转换为 String。

impl !Send for TokenStream

impl !Sync for TokenStream