结构体 TokenStream

pub struct TokenStream(/* private fields */);

此 crate 提供的主要类型，表示 token 的抽象流，或者更具体地说，是 token 树的序列。此类型提供了用于迭代这些 token 树的接口，反之，也提供了将多个 token 树收集到一个流中的接口。

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

实现

impl TokenStream

pub fn new() -> TokenStream

返回一个不包含任何 token 树的空 TokenStream。

pub fn is_empty(&self) -> bool

检查此 TokenStream 是否为空。

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

🔬这是一个仅限 nightly 版本的实验性 API。(proc_macro_expand #90765)

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

目前，只有展开为字面量的表达式才会成功，尽管未来可能会放宽此限制。

注意：在错误情况下，expand_expr 可能会保持宏未展开、报告错误、导致编译失败和/或返回 Err(..)。任何错误情况的具体行为，以及哪些情况被认为是错误，都是未指定的，并且将来可能会更改。

Trait 实现

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

使用给定的 formatter 格式化值。 阅读更多

impl Default for TokenStream

fn default() -> Self

返回类型的“默认值”。 阅读更多

impl Display for TokenStream

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

注意：输出的确切形式可能会更改，例如，token 之间使用的空格可能会发生变化。因此，您不应对输出字符串（由 to_string 生成）执行任何类型的简单子字符串匹配来实现 proc 宏，因为如果发生此类更改，该匹配可能会停止工作。相反，您应该在 TokenTree 级别工作，例如，匹配 TokenTree::Ident、TokenTree::Punct 或 TokenTree::Literal。

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

使用给定的 formatter 格式化值。 阅读更多

impl Extend<TokenStream> for TokenStream

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

使用迭代器的内容扩展集合。 阅读更多

fn extend_one(&mut self, item: A)

🔬这是一个仅限 nightly 版本的实验性 API。(extend_one #72631)

使用一个元素扩展集合。

fn extend_reserve(&mut self, additional: usize)

🔬这是一个仅限 nightly 版本的实验性 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)

🔬这是一个仅限 nightly 版本的实验性 API。(extend_one #72631)

使用一个元素扩展集合。

fn extend_reserve(&mut self, additional: usize)

🔬这是一个仅限 nightly 版本的实验性 API。(extend_one #72631)

在集合中为给定数量的额外元素预留容量。 阅读更多

impl From<TokenTree> for TokenStream

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

fn from(tree: TokenTree) -> TokenStream

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

impl FromIterator<TokenStream> for TokenStream

token 流上的“展平”操作，从多个 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

尝试将字符串分解为 token，并将这些 token 解析为 token 流。可能会因多种原因失败，例如，如果字符串包含不平衡的分隔符或语言中不存在的字符。解析流中的所有 token 都获得 Span::call_site() span。

注意：某些错误可能会导致 panic 而不是返回 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 ToTokens for TokenStream

fn to_tokens(&self, tokens: &mut TokenStream)

🔬这是一个仅限 nightly 版本的实验性 API。(proc_macro_totokens #130977)

将 self 写入给定的 TokenStream。 阅读更多

fn into_token_stream(self) -> TokenStream

🔬这是一个仅限 nightly 版本的实验性 API。(proc_macro_totokens #130977)

将 self 直接转换为 TokenStream 对象。 阅读更多

fn to_token_stream(&self) -> TokenStream

🔬这是一个仅限 nightly 版本的实验性 API。(proc_macro_totokens #130977)

将 self 直接转换为 TokenStream 对象。 阅读更多

impl !Send for TokenStream

impl !Sync for TokenStream