Struct RealFileName 

pub struct RealFileName {
    pub(crate) local: Option<InnerRealFileName>,
    pub(crate) maybe_remapped: InnerRealFileName,
    pub(crate) scopes: RemapPathScopeComponents,
}

A self-contained “real” filename.

It is produced by SourceMap::to_real_filename.

RealFileName represents a filename that may have been (partly) remapped by --remap-path-prefix and -Zremap-path-scope.

It also contains an embedabble component which gives a working directory and a maybe-remapped maybe-aboslote name. This is useful for debuginfo where some formats and tools highly prefer absolute paths.

Consistency across compiler sessions

The type-system, const-eval and other parts of the compiler rely on FileName and by extension RealFileName to be consistent across compiler sessions.

Otherwise unsoudness (like rust-lang/rust#148328) may occur.

As such this type is self-sufficient and consistent in it’s output.

The RealFileName::path and RealFileName::embeddable_name methods are guaranteed to always return the same output across compiler sessions.

Usage

Creation of a RealFileName should be done using FilePathMapping::to_real_filename.

Retrieving a path can be done in two main ways:

• by using RealFileName::path with a given scope (should be preferred)
• or by using RealFileName::embeddable_name with a given scope

Fields

local: Option<InnerRealFileName>

The local name (always present in the original crate)

maybe_remapped: InnerRealFileName

The maybe remapped part. Correspond to local when no remapped happened.

scopes: RemapPathScopeComponents

The remapped scopes. Any active scope MUST use maybe_virtual

Implementations

impl RealFileName

pub fn path(&self, scope: RemapPathScopeComponents) -> &Path

Returns the associated path for the given remapping scope.

Panic

Only one scope components can be given to this function.

pub fn embeddable_name(&self, scope: RemapPathScopeComponents) -> (&Path, &Path)

Returns the working directory and embeddable path for the given remapping scope.

Useful for embedding a mostly abosolute path (modulo remapping) in the compiler outputs.

The embedabble path is not guaranteed to be an absolute path, nor is it garuenteed that the working directory part is always a prefix of embeddable path.

Panic

Only one scope components can be given to this function.

pub fn local_path(&self) -> Option<&Path>

Returns the path suitable for reading from the file system on the local host, if this information exists.

May not exists if the filename was imported from another crate.

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.

May not exists if the filename was imported from another crate.

pub(crate) fn was_remapped(&self) -> bool

Returns whenever the filename was remapped.

pub fn empty() -> RealFileName

Returns an empty RealFileName

Useful as the working directory input to SourceMap::to_real_filename.

pub fn from_virtual_path(path: &Path) -> RealFileName

Returns a RealFileName that is completely remapped without any local components.

Only exposed for the purpose of -Zsimulate-remapped-rust-src-base.

pub fn update_for_crate_metadata(&mut self)

Update the filename for encoding in the crate metadata.

Currently it’s about removing the local part when the filename is fully remapped.

pub(crate) fn to_string_lossy<'a>( &'a self, display_pref: FileNameDisplayPreference, ) -> Cow<'a, str>

Internal routine to display the filename.

Users should always use the RealFileName::path method or FileName methods instead.

Trait Implementations

impl Clone for RealFileName

fn clone(&self) -> RealFileName

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RealFileName

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

Formats the value using the given formatter.

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

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

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

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

impl Hash for RealFileName

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 RealFileName

fn cmp(&self, other: &RealFileName) -> 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 RealFileName

fn eq(&self, other: &RealFileName) -> 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 RealFileName

fn partial_cmp(&self, other: &RealFileName) -> 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 RealFileName

impl StructuralPartialEq for RealFileName

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: 152 bytes