## FilePathMapping

# Struct FilePathMapping

Source

    pub struct FilePathMapping {
        mapping: Vec<(PathBuf, PathBuf)>,
        filename_display_for_diagnostics: FileNameDisplayPreference,
        filename_embeddable_preference: FileNameEmbeddablePreference,
    }

## Fields§

§`mapping: Vec<(PathBuf, PathBuf)>`§`filename_display_for_diagnostics: FileNameDisplayPreference`§`filename_embeddable_preference: FileNameEmbeddablePreference`

## Implementations§

Source§

### impl FilePathMapping

Source

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

Source

#### pub fn new( mapping: Vec<(PathBuf, PathBuf)>, filename_display_for_diagnostics: FileNameDisplayPreference, filename_embeddable_preference: FileNameEmbeddablePreference, ) -> FilePathMapping

Source

#### pub fn map_prefix<'a>( &'a self, path: impl Into<Cow<'a, Path>>, ) -> (Cow<'a, Path>, bool)

Applies any path prefix substitution as defined by the mapping. The return value is the remapped path and a boolean indicating whether the path was affected by the mapping.

Source

#### fn map_filename_prefix(&self, file: &FileName) -> (FileName, bool)

Source

#### pub fn to_real_filename<'a>( &self, local_path: impl Into<Cow<'a, Path>>, ) -> RealFileName

Applies any path prefix substitution as defined by the mapping. The return value is the local path with a “virtual path” representing the remapped part if any remapping was performed.

Source

#### pub fn to_embeddable_absolute_path( &self, file_path: RealFileName, working_directory: &RealFileName, ) -> RealFileName

Expand a relative path to an absolute path with remapping taken into account. Use this when absolute paths are required (e.g. debuginfo or crate metadata).

The resulting `RealFileName` will have its `local_path` portion erased if possible (i.e. if there’s also a remapped path).

Source

#### fn reverse_map_prefix_heuristically(&self, path: &Path) -> Option<PathBuf>

Attempts to (heuristically) reverse a prefix mapping.

Returns `Some` if there is exactly one mapping where the “to” part is a prefix of `path` and has at least one non-empty `Normal` component. The component restriction exists to avoid reverse mapping overly generic paths like `/` or `.`).

This is a heuristic and not guaranteed to return the actual original path! Do not rely on the result unless you have other means to verify that the mapping is correct (e.g. by checking the file content hash).

## Trait Implementations§

Source§

### impl Clone for FilePathMapping

Source§

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

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from `source`. Read more

## Auto Trait Implementations§

§

### impl DynSend for FilePathMapping

§

### impl DynSync for FilePathMapping

§

### impl Freeze for FilePathMapping

§

### impl RefUnwindSafe for FilePathMapping

§

### impl Send for FilePathMapping

§

### impl Sync for FilePathMapping

§

### impl Unpin for FilePathMapping

§

### impl UnwindSafe for FilePathMapping

## 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<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: 32 bytes