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

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

    pub struct Span(_);

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_span` #38356)

A span that resolves at the macro definition site.

####

`pub fn call_site() -> Span`

[src]

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 source_file(&self) -> SourceFile`

[src]

🔬 This is a nightly-only experimental API. (`proc_macro_span` #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_span` #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_span` #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_span` #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_span` #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_span` #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_span` #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_span` #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_span` #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_diagnostic` #54140)

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_diagnostic` #54140)

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_diagnostic` #54140)

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_diagnostic` #54140)

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]

Prints a span in a form convenient for debugging.

####

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

## Blanket Implementations

###

`impl<T> ToOwned for T where T: Clone,`

[src]

#### `type Owned = T`

####

`fn to_owned(&self) -> T`

[src]

Creates owned data from borrowed data, usually by cloning. Read more

####

`fn clone_into(&self, target: &mut T)`

[src]

🔬 This is a nightly-only experimental API. (`toowned_clone_into` #41263)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

###

`impl<T, U> Into for T where U: From<T>,`

[src]

####

`fn into(self) -> U`

[src]

Performs the conversion.

###

`impl<T> From for T`

[src]

####

`fn from(t: T) -> T`

[src]

Performs the conversion.

###

`impl<T, U> TryFrom for T where T: From<U>,`

[src]

#### `type Error = !`

🔬 This is a nightly-only experimental API. (`try_from` #33417)

The type returned in the event of a conversion error.

####

`fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`

[src]

🔬 This is a nightly-only experimental API. (`try_from` #33417)

Performs the conversion.

###

`impl<T> Borrow for T where T: ?Sized,`

[src]

####

`fn borrow(&self) -> &T`

[src]

Immutably borrows from an owned value. Read more

###

`impl<T> Any for T where T: 'static + ?Sized,`

[src]

####

`fn get_type_id(&self) -> TypeId`

[src]

🔬 This is a nightly-only experimental API. (`get_type_id` #27745)

this method will likely be replaced by an associated static

Gets the `TypeId` of `self`. Read more

###

`impl<T, U> TryInto for T where U: TryFrom<T>,`

[src]

#### `type Error = <U as TryFrom<T>>::Error`

🔬 This is a nightly-only experimental API. (`try_from` #33417)

The type returned in the event of a conversion error.

####

`fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`

[src]

🔬 This is a nightly-only experimental API. (`try_from` #33417)

Performs the conversion.

###

`impl<T> BorrowMut for T where T: ?Sized,`

[src]

####

`fn borrow_mut(&mut self) -> &mut T`

[src]

Mutably borrows from an owned value. Read more

###

`impl<E> SpecializationError for E`

[src]

####

`fn not_found<S, T>(trait_name: &'static str, method_name: &'static str) -> E where T: ?Sized,`

[src]

🔬 This is a nightly-only experimental API. (`rustc_private` #27812)

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via `Cargo.toml` instead?

Create an error for a missing method specialization. Defaults to panicking with type, trait & method names. `S` is the encoder/decoder state type, `T` is the type being encoded/decoded, and the arguments are the names of the trait and method that should've been overridden. Read more

###

`impl<T> Erased for T`

[src]

###

`impl<T> Send for T where T: ?Sized,`

[src]

###

`impl<T> Sync for T where T: ?Sized,`

[src]

###

`impl<T> Erased for T`

# 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`)