proc_macro::Span - Rust
Description: API documentation for the Rust `Span` struct in crate `proc_macro`.
Keywords: rust, rustlang, rust-lang, Span

# 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 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 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 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 Debug for Span`
[src]

#### `fn fmt(&self, __arg_0: &mut Formatter) -> Result`
[src]

Formats the value using the given formatter.

### `impl PartialEq for Span`
[src]

#### `fn eq(&self, __arg_0: &Span) -> bool`
[src]

This method tests for `self` and `other` values to be equal, and is used by `==`. Read more

#### `fn ne(&self, __arg_0: &Span) -> bool`
[src]

This method tests for `!=`.

### `impl Eq for Span`
[src]

### `impl Default for Span`
[src]

#### `fn default() -> Span`
[src]

Returns the "default value" for a type. Read more

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result
+
  Collapse/expand 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`)