Struct proc_macro::SourceFile

pub struct SourceFile { /* fields omitted */ }

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

The source file of a given Span.

Methods

impl SourceFile

pub fn path(&self) -> PathBuf

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

Get 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

🔬 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

fn clone(&self) -> SourceFile

Returns a copy of the value.

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

Performs copy-assignment from source.

impl !Sync for SourceFile

impl Eq for SourceFile

impl PartialEq<SourceFile> for SourceFile

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

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

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

This method tests for !=.

impl !Send for SourceFile

impl Debug for SourceFile

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.