Struct proc_macro::Span

pub struct Span(_);

A region of source code, along with macro expansion information.

Implementations

impl Span

pub fn def_site() -> Span

🔬 This is a nightly-only experimental API. (proc_macro_def_site #54724)

A span that resolves at the macro definition site.

pub fn call_site() -> Span

The span of the invocation of the current procedural macro. Identifiers created with this span will be resolved as if they were written directly at the macro call location (call-site hygiene) and other code at the macro call site will be able to refer to them as well.

pub fn mixed_site() -> Span

A span that represents macro_rules hygiene, and sometimes resolves at the macro definition site (local variables, labels, $crate) and sometimes at the macro call site (everything else). The span location is taken from the call-site.

pub fn source_file(&self) -> SourceFile

🔬 This is a nightly-only experimental API. (proc_macro_span #54725)

The original source file into which this span points.

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

🔬 This is a nightly-only experimental API. (proc_macro_span #54725)

The Span for the tokens in the previous macro expansion from which self was generated from, if any.

pub fn source(&self) -> Span

🔬 This is a nightly-only experimental API. (proc_macro_span #54725)

The span for the origin source code that self was generated from. If this Span wasn’t generated from other macro expansions then the return value is the same as *self.

pub fn start(&self) -> LineColumn

🔬 This is a nightly-only experimental API. (proc_macro_span #54725)

Gets the starting line/column in the source file for this span.

pub fn end(&self) -> LineColumn

🔬 This is a nightly-only experimental API. (proc_macro_span #54725)

Gets the ending line/column in the source file for this span.

pub fn before(&self) -> Span

🔬 This is a nightly-only experimental API. (proc_macro_span_shrink #87552)

Creates an empty span pointing to directly before this span.

pub fn after(&self) -> Span

🔬 This is a nightly-only experimental API. (proc_macro_span_shrink #87552)

Creates an empty span pointing to directly after this span.

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

🔬 This is a nightly-only experimental API. (proc_macro_span #54725)

Creates a new span encompassing self and other.

Returns None if self and other are from different files.

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

Creates a new span with the same line/column information as self but that resolves symbols as though it were at other.

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

Creates a new span with the same name resolution behavior as self but with the line/column information of other.

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

🔬 This is a nightly-only experimental API. (proc_macro_span #54725)

Compares to spans to see if they’re equal.

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

🔬 This is a nightly-only experimental API. (proc_macro_span #54725)

Returns the source text behind a span. This preserves the original source code, including spaces and comments. It only returns a result if the span corresponds to real source code.

Note: The observable result of a macro should only rely on the tokens and not on this source text. The result of this function is a best effort to be used for diagnostics only.

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

🔬 This is a nightly-only experimental API. (proc_macro_diagnostic #54140)

Creates a new Diagnostic with the given message at the span self.

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

🔬 This is a nightly-only experimental API. (proc_macro_diagnostic #54140)

Creates a new Diagnostic with the given message at the span self.

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

🔬 This is a nightly-only experimental API. (proc_macro_diagnostic #54140)

Creates a new Diagnostic with the given message at the span self.

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

🔬 This is a nightly-only experimental API. (proc_macro_diagnostic #54140)

Creates a new Diagnostic with the given message at the span self.

Trait Implementations

impl Clone for Span

fn clone(&self) -> Span

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Span

Prints a span in a form convenient for debugging.

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

Formats the value using the given formatter.

impl MultiSpan for Span

fn into_spans(self) -> Vec<Span>

🔬 This is a nightly-only experimental API. (proc_macro_diagnostic #54140)

Converts self into a Vec<Span>.

impl Copy for Span

impl !Send for Span

impl !Sync for Span