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

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

    pub struct SourceFile { /* fields omitted */ }

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

The source file of a given `Span`.

## Methods

### `impl SourceFile`
[src]

#### `pub fn path(&self) -> &FileName`
[src]

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

Get the path to this source file.

### Note

If the code span associated with this `SourceFile` was generated by an external macro, this may not be an actual path on the filesystem. Use `is_real` to check.

Also note that even if `is_real` returns `true`, if `-Z remap-path-prefix-*` was passed on the command line, the path as given may not actually be valid.

#### `pub fn is_real(&self) -> bool`
[src]

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

Returns `true` if this source file is a real source file, and not generated by an external macro's expansion.

## Trait Implementations

### `impl Clone for SourceFile`
[src]

#### `fn clone(&self) -> SourceFile`
[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 AsRef<FileName> for SourceFile`
[src]

#### `fn as_ref(&self) -> &FileName`
[src]

Performs the conversion.

### `impl Debug for SourceFile`
[src]

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

Formats the value using the given formatter. Read more

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

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

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

#### `fn ne(&self, other: &Rhs) -> bool`
1.0.0
[src]

This method tests for `!=`.

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

### `impl PartialEq<FileName> for SourceFile`
[src]

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

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

#### `fn ne(&self, other: &Rhs) -> bool`
1.0.0
[src]

This method tests for `!=`.

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