Struct proc_macro2::Span

pub struct Span { /* fields omitted */ }

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

Methods

impl Span

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 def_site() -> Span

A span that resolves at the macro definition site.

This method is semver exempt and not exposed by default.

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.

This method is semver exempt and not exposed by default.

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.

This method is semver exempt and not exposed by default.

pub fn unwrap(self) -> Span

Convert proc_macro2::Span to proc_macro::Span.

This method is available when building with a nightly compiler, or when building with rustc 1.29+ without semver exempt features.

Panics

Panics if called from outside of a procedural macro. Unlike proc_macro2::Span, the proc_macro::Span type can only exist within the context of a procedural macro invocation.

pub fn source_file(&self) -> SourceFile

The original source file into which this span points.

This method is semver exempt and not exposed by default.

pub fn start(&self) -> LineColumn

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

This method is semver exempt and not exposed by default.

pub fn end(&self) -> LineColumn

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

This method is semver exempt and not exposed by default.

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

Create a new span encompassing self and other.

Returns None if self and other are from different files.

This method is semver exempt and not exposed by default.

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

Compares to spans to see if they're equal.

This method is semver exempt and not exposed by default.

Trait Implementations

impl From<Span> for Span

fn from(proc_span: Span) -> Span

Performs the conversion.

impl Copy for Span

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.