# Struct proc_macro::Span[−][src]

    pub struct Span(_);

🔬 This is a nightly-only experimental API. (`proc_macro` #38356)

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

## Methods

###

`impl Span`

[src]

####

`pub fn def_site() -> Span`

[src]

🔬 This is a nightly-only experimental API. (`proc_macro` #38356)

A span that resolves at the macro definition site.

####

`pub fn call_site() -> Span`

[src]

🔬 This is a nightly-only experimental API. (`proc_macro` #38356)

The span of the invocation of the current procedural macro.

####

`pub fn source_file(&self) -> SourceFile`

[src]

🔬 This is a nightly-only experimental API. (`proc_macro` #38356)

The original source file into which this span points.

####

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

[src]

🔬 This is a nightly-only experimental API. (`proc_macro` #38356)

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

####

`pub fn source(&self) -> Span`

[src]

🔬 This is a nightly-only experimental API. (`proc_macro` #38356)

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`

[src]

🔬 This is a nightly-only experimental API. (`proc_macro` #38356)

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

####

`pub fn end(&self) -> LineColumn`

[src]

🔬 This is a nightly-only experimental API. (`proc_macro` #38356)

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

####

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

[src]

🔬 This is a nightly-only experimental API. (`proc_macro` #38356)

Create 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`

[src]

🔬 This is a nightly-only experimental API. (`proc_macro` #38356)

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`

[src]

🔬 This is a nightly-only experimental API. (`proc_macro` #38356)

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`

[src]

🔬 This is a nightly-only experimental API. (`proc_macro` #38356)

Compares to spans to see if they're equal.

####

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

[src]

🔬 This is a nightly-only experimental API. (`proc_macro` #38356)

Create a new `Diagnostic` with the given `message` at the span `self`.

####

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

[src]

🔬 This is a nightly-only experimental API. (`proc_macro` #38356)

Create a new `Diagnostic` with the given `message` at the span `self`.

####

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

[src]

🔬 This is a nightly-only experimental API. (`proc_macro` #38356)

Create a new `Diagnostic` with the given `message` at the span `self`.

####

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

[src]

🔬 This is a nightly-only experimental API. (`proc_macro` #38356)

Create a new `Diagnostic` with the given `message` at the span `self`.

## Trait Implementations

###

`impl Copy for Span`

[src]

###

`impl Clone for Span`

[src]

####

`fn clone(&self) -> Span`

[src]

Returns a copy of the value. Read more

####

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

1.0.0
[src]

Performs copy-assignment from `source`. Read more

###

`impl !Send for Span`

[src]

###

`impl !Sync for Span`

[src]

###

`impl Debug for Span`

[src]

####

`fn fmt(&self, f: &mut Formatter) -> Result`

[src]

Formats the value using the given formatter. Read more

## Auto Trait Implementations

###

`impl !Send for Span`

###

`impl !Sync for Span`

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g. `str,u8` or `String,struct:Vec,test`)