RealFileName in rustc_span - Rust
Description: A self-contained “real” filename.

Skip to main content

## RealFileName

# Struct RealFileName

Source

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

Expand description

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§

Source§

### impl RealFileName

Source

#### 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.

Source

#### 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.

Source

#### 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.

Avoid embedding this in build artifacts; prefer `path()` or `embeddable_name()`.

Source

#### 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.

Avoid embedding this in build artifacts; prefer `path()` or `embeddable_name()`.

Source

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

Returns whenever the filename was remapped.

Source

#### pub(crate) fn was_fully_remapped(&self) -> bool

Returns whenever the filename was fully remapped.

Source

#### pub(crate) fn was_not_remapped(&self) -> bool

Returns whenever the filename was not remapped.

Source

#### pub fn empty() -> RealFileName

Returns an empty `RealFileName`

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

Source

#### 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`.

Source

#### 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 either fully remapped or not remapped at all.

Source

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

Source§

### impl Clone for RealFileName

Source§

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

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

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

### impl Debug for RealFileName

Source§

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

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

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

Source§

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

Source§

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

Source§

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

Source§

### impl Hash for RealFileName

Source§

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

Feeds this value into the given `Hasher`. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given `Hasher`. Read more
Source§

### impl Ord for RealFileName

Source§

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

This method returns an `Ordering` between `self` and `other`. Read more
1.21.0 (const: unstable) · Source§

#### fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

#### fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

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

Restrict a value to a certain interval. Read more
Source§

### impl PartialEq for RealFileName

Source§

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

Tests for `self` and `other` values to be equal, and is used by `==`.
1.0.0 (const: unstable) · Source§

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

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

### impl PartialOrd for RealFileName

Source§

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

This method returns an ordering between `self` and `other` values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for `self` and `other`) and is used by the `<` operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for `self` and `other`) and is used by the `<=` operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for `self` and `other`) and is used by the `>` operator. Read more
1.0.0 (const: unstable) · Source§

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

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

### impl Eq for RealFileName

Source§

### impl StructuralPartialEq for RealFileName

## Auto Trait Implementations§

§

### impl DynSend for RealFileName

§

### impl DynSync for RealFileName

§

### impl Freeze for RealFileName

§

### impl RefUnwindSafe for RealFileName

§

### impl Send for RealFileName

§

### impl Sync for RealFileName

§

### impl Unpin for RealFileName

§

### impl UnsafeUnpin for RealFileName

§

### impl UnwindSafe for RealFileName

## Blanket Implementations§

Source§

### impl<T> Aligned for T

Source§

#### const ALIGN: Alignment

Alignment of `Self`.
Source§

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

Source§

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

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

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

Source§

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

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

### impl<T> CloneToUninit for T
where T: Clone,

Source§

#### unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (`clone_to_uninit`)
Performs copy-assignment from `self` to `dest`. Read more
Source§

### impl<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

Source§

#### fn compare(&self, key: &K) -> Ordering

Compare self to `key` and return their ordering.
Source§

### impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

#### fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

### impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

#### fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

### impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

#### fn equivalent(&self, key: &K) -> bool

Compare self to `key` and return `true` if they are equal.
Source§

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

Source§

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

Returns the argument unchanged.

Source§

### impl<T> Instrument for T

Source§

#### fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided `Span`, returning an `Instrumented` wrapper. Read more
Source§

#### fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current `Span`, returning an `Instrumented` wrapper. Read more
Source§

### impl<T, U> Into<U> for T
where 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> IntoEither for T

Source§

#### fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts `self` into a `Left` variant of `Either<Self, Self>` if `into_left` is `true`. Converts `self` into a `Right` variant of `Either<Self, Self>` otherwise. Read more
Source§

#### fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts `self` into a `Left` variant of `Either<Self, Self>` if `into_left(&self)` returns `true`. Converts `self` into a `Right` variant of `Either<Self, Self>` otherwise. Read more
Source§

### impl<T> Pointable for T

Source§

#### const ALIGN: usize

The alignment of pointer.
Source§

#### type Init = T

The type for initializers.
Source§

#### unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

#### unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

#### unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

#### unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

### impl<T> Same for T

Source§

#### type Output = T

Should always be `Self`
Source§

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

Source§

#### 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 T
where U: Into<T>,

Source§

#### 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 T
where U: TryFrom<T>,

Source§

#### 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.
Source§

### impl<T> WithSubscriber for T

Source§

#### fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided `Subscriber` to this type, returning a `WithDispatch` wrapper. Read more
Source§

#### fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default `Subscriber` to this type, returning a `WithDispatch` wrapper. Read more

## 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