Struct FilePathMapping

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

Fields

mapping: Vec<(PathBuf, PathBuf)>

filename_display_for_diagnostics: FileNameDisplayPreference

Implementations

impl FilePathMapping

pub fn empty() -> FilePathMapping

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

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.

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

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.

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

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

Expand a relative path to an absolute path without remapping taken into account.

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

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

impl Clone for FilePathMapping

fn clone(&self) -> FilePathMapping

Returns a copy of the value.

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

Performs copy-assignment from source.

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