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

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

    pub struct SourceFile(_);

🔬 This is a nightly-only experimental API. (`proc_macro_span` #54725)

The source file of a given `Span`.

## Implementations

### `impl SourceFile`[src]

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

🔬 This is a nightly-only experimental API. (`proc_macro_span` #54725)

Gets the path to this source file.

### Note

If the code span associated with this `SourceFile` was generated by an external macro, this 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 `--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_span` #54725)

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

#### `pub fn clone_from(&mut self, source: &Self)`1.0.0[src]

Performs copy-assignment from `source`. Read more

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

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

Formats the value using the given formatter. Read more

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

### `impl PartialEq<SourceFile> 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

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

This method tests for `!=`.

## Auto Trait Implementations

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

### `impl !Send for SourceFile`[src]

### `impl !Sync for SourceFile`[src]

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

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

## Blanket Implementations

### `impl<T> Any for T where
T: 'static + ?Sized,` [src]

#### `pub fn type_id(&self) -> TypeId`[src]

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

### `impl<T> Borrow<T> for T where
T: ?Sized,` [src]

#### `pub fn borrow(&self) -> &T`[src]

Immutably borrows from an owned value. Read more

### `impl<T> BorrowMut<T> for T where
T: ?Sized,` [src]

#### `pub fn borrow_mut(&mut self) -> &mut T`[src]

Mutably borrows from an owned value. Read more

### `impl<T> From<T> for T`[src]

#### `pub fn from(t: T) -> T`[src]

Performs the conversion.

### `impl<T, U> Into<U> for T where
U: From<T>,` [src]

#### `pub fn into(self) -> U`[src]

Performs the conversion.

### `impl<T> ToOwned for T where
T: Clone,` [src]

#### `type Owned = T`

The resulting type after obtaining ownership.

#### `pub fn to_owned(&self) -> T`[src]

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

#### `pub 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> TryFrom<U> for T where
U: Into<T>,` [src]

#### `type Error = Infallible`

The type returned in the event of a conversion error.

#### `pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`[src]

Performs the conversion.

### `impl<T, U> TryInto<U> for T where
U: TryFrom<T>,` [src]

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

The type returned in the event of a conversion error.

#### `pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`[src]

Performs the conversion.