结构体 Span

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

源代码区域，以及宏展开信息。

实现

impl Span

pub fn def_site() -> Span

🔬这是一个仅限 nightly 的实验性 API。(proc_macro_def_site #54724)

一个在宏定义位置解析的 span。

pub fn call_site() -> Span

当前过程宏调用的 span。使用此 span 创建的标识符将被解析为好像它们直接写在宏调用位置（调用位置卫生），并且宏调用位置的其他代码也将能够引用它们。

pub fn mixed_site() -> Span

一个表示 macro_rules 卫生的 span，有时在宏定义位置（局部变量、标签、$crate）解析，有时在宏调用位置（其他所有内容）解析。span 位置取自调用位置。

pub fn source_file(&self) -> SourceFile

🔬这是一个仅限 nightly 的实验性 API。(proc_macro_span #54725)

此 span 指向的原始源文件。

pub fn parent(&self) -> Option<Span>

🔬这是一个仅限 nightly 的实验性 API。(proc_macro_span #54725)

从中生成 self 的先前宏展开中的 token 的 Span，如果有的话。

pub fn source(&self) -> Span

🔬这是一个仅限 nightly 的实验性 API。(proc_macro_span #54725)

从中生成 self 的原始源代码的 span。如果此 Span 不是从其他宏展开生成的，则返回值与 *self 相同。

pub fn byte_range(&self) -> Range<usize>

🔬这是一个仅限 nightly 的实验性 API。(proc_macro_span #54725)

返回 span 在源文件中的字节位置范围。

pub fn start(&self) -> Span

🔬这是一个仅限 nightly 的实验性 API。(proc_macro_span #54725)

创建一个空 span，指向此 span 正前方。

pub fn end(&self) -> Span

🔬这是一个仅限 nightly 的实验性 API。(proc_macro_span #54725)

创建一个空 span，指向此 span 正后方。

pub fn line(&self) -> usize

🔬这是一个仅限 nightly 的实验性 API。(proc_macro_span #54725)

span 开始位置的源文件中的一行，从 1 开始计数。

要获取 span 结束位置的行号，请使用 span.end().line()。

pub fn column(&self) -> usize

🔬这是一个仅限 nightly 的实验性 API。(proc_macro_span #54725)

span 开始位置的源文件中的一列，从 1 开始计数。

要获取 span 结束位置的列号，请使用 span.end().column()。

pub fn join(&self, other: Span) -> Option<Span>

🔬这是一个仅限 nightly 的实验性 API。(proc_macro_span #54725)

创建一个新的 span，包含 self 和 other。

如果 self 和 other 来自不同的文件，则返回 None。

pub fn resolved_at(&self, other: Span) -> Span

创建一个新的 span，其行/列信息与 self 相同，但在解析符号时，就好像它位于 other。

pub fn located_at(&self, other: Span) -> Span

创建一个新的 span，其名称解析行为与 self 相同，但具有 other 的行/列信息。

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

🔬这是一个仅限 nightly 的实验性 API。(proc_macro_span #54725)

比较两个 span 以查看它们是否相等。

pub fn source_text(&self) -> Option<String>

返回 span 背后的源代码文本。这保留了原始源代码，包括空格和注释。仅当 span 对应于真实源代码时，它才会返回结果。

注意：宏的 observable 结果应该只依赖于 token，而不是这个源代码文本。此函数的结果是尽力而为，仅用于诊断。

pub fn error<T: Into<String>>(self, message: T) -> Diagnostic

🔬这是一个仅限 nightly 的实验性 API。(proc_macro_diagnostic #54140)

在 span self 处使用给定的 message 创建一个新的 Diagnostic。

pub fn warning<T: Into<String>>(self, message: T) -> Diagnostic

🔬这是一个仅限 nightly 的实验性 API。(proc_macro_diagnostic #54140)

在 span self 处使用给定的 message 创建一个新的 Diagnostic。

pub fn note<T: Into<String>>(self, message: T) -> Diagnostic

🔬这是一个仅限 nightly 的实验性 API。(proc_macro_diagnostic #54140)

在 span self 处使用给定的 message 创建一个新的 Diagnostic。

pub fn help<T: Into<String>>(self, message: T) -> Diagnostic

🔬这是一个仅限 nightly 的实验性 API。(proc_macro_diagnostic #54140)

在 span self 处使用给定的 message 创建一个新的 Diagnostic。

Trait 实现

impl Clone for Span

fn clone(&self) -> Span

返回值的副本。 阅读更多

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

从 source 执行复制赋值。 阅读更多

impl Debug for Span

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

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

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

impl MultiSpan for Span

fn into_spans(self) -> Vec<Span>

🔬这是一个仅限 nightly 的实验性 API。(proc_macro_diagnostic #54140)

将 self 转换为 Vec<Span>。

impl Copy for Span

impl !Send for Span

impl !Sync for Span