Enum FileName

pub enum FileName {
    Real(RealFileName),
    QuoteExpansion(Hash64),
    Anon(Hash64),
    MacroExpansion(Hash64),
    ProcMacroSourceCode(Hash64),
    CliCrateAttr(Hash64),
    Custom(String),
    DocTest(PathBuf, isize),
    InlineAsm(Hash64),
}

Differentiates between real files and common virtual files.

Variants

Real(RealFileName)

QuoteExpansion(Hash64)

Call to quote!.

Anon(Hash64)

Command line.

MacroExpansion(Hash64)

Hack in src/librustc_ast/parse.rs.

ProcMacroSourceCode(Hash64)

CliCrateAttr(Hash64)

Strings provided as crate attributes in the CLI.

Custom(String)

Custom sources for explicit parser calls from plugins and drivers.

DocTest(PathBuf, isize)

InlineAsm(Hash64)

Post-substitution inline assembly from LLVM.

Implementations

impl FileName

pub fn is_real(&self) -> bool

pub fn prefer_remapped_unconditionaly(&self) -> FileNameDisplay<'_>

pub fn prefer_local(&self) -> FileNameDisplay<'_>

This may include transient local filesystem information. Must not be embedded in build outputs.

pub fn display( &self, display_pref: FileNameDisplayPreference, ) -> FileNameDisplay<'_>

pub fn macro_expansion_source_code(src: &str) -> FileName

pub fn anon_source_code(src: &str) -> FileName

pub fn proc_macro_source_code(src: &str) -> FileName

pub fn cfg_spec_source_code(src: &str) -> FileName

pub fn cli_crate_attr_source_code(src: &str) -> FileName

pub fn doc_test_source_code(path: PathBuf, line: isize) -> FileName

pub fn inline_asm_source_code(src: &str) -> FileName

pub fn into_local_path(self) -> Option<PathBuf>

Returns the path suitable for reading from the file system on the local host, if this information exists. Avoid embedding this in build artifacts; see remapped_path_if_available() for that.

Trait Implementations

impl Clone for FileName

fn clone(&self) -> FileName

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FileName

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

Formats the value using the given formatter.

impl<__D: SpanDecoder> Decodable<__D> for FileName

fn decode(__decoder: &mut __D) -> Self

impl<__E: SpanEncoder> Encodable<__E> for FileName

fn encode(&self, __encoder: &mut __E)

impl From<PathBuf> for FileName

fn from(p: PathBuf) -> Self

Converts to this type from the input type.

impl Hash for FileName

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for FileName

fn cmp(&self, other: &FileName) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for FileName

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for FileName

fn partial_cmp(&self, other: &FileName) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for FileName

impl StructuralPartialEq for FileName

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 48 bytes

Size for each variant:

• Real: 48 bytes
• QuoteExpansion: 16 bytes
• Anon: 16 bytes
• MacroExpansion: 16 bytes
• ProcMacroSourceCode: 16 bytes
• CliCrateAttr: 16 bytes
• Custom: 32 bytes
• DocTest: 40 bytes
• InlineAsm: 16 bytes