# Struct proc_macro::SourceFile

source ·

    pub struct SourceFile(/* private fields */);

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

The source file of a given `Span`.

## Implementations§

source§

### impl SourceFile

source

#### pub fn path(&self) -> PathBuf

🔬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 might 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 might not actually be valid.

source

#### pub fn is_real(&self) -> bool

🔬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§

source§

### impl Clone for SourceFile

source§

#### fn clone(&self) -> SourceFile

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from `source`. Read more
source§

### impl Debug for SourceFile

source§

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

Formats the value using the given formatter. Read more
source§

### impl PartialEq for SourceFile

source§

#### fn eq(&self, other: &Self) -> bool

This method tests for `self` and `other` values to be equal, and is used by `==`.
1.0.0 · source§

#### fn ne(&self, other: &Rhs) -> bool

This method tests for `!=`. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

### impl Eq for SourceFile

## Auto Trait Implementations§

§

### impl RefUnwindSafe for SourceFile

§

### impl !Send for SourceFile

§

### impl !Sync for SourceFile

§

### impl Unpin for SourceFile

§

### impl UnwindSafe for SourceFile

## Blanket Implementations§

source§

### impl<T> Any for Twhere T: 'static + ?Sized,

source§

#### fn type_id(&self) -> TypeId

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

### impl<T> Borrow<T> for Twhere T: ?Sized,

source§

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

Immutably borrows from an owned value. Read more
source§

### impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

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

Mutably borrows from an owned value. Read more
source§

### impl<T> From<T> for T

source§

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

Returns the argument unchanged.

source§

### impl<T, U> Into<U> for Twhere U: From<T>,

source§

#### fn into(self) -> U

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

source§

### impl<T> ToOwned for Twhere T: Clone,

§

#### type Owned = T

The resulting type after obtaining ownership.
source§

#### fn to_owned(&self) -> T

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

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

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

### impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

#### type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

### impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

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

The type returned in the event of a conversion error.
source§

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

Performs the conversion.