Enum rustc_span::RealFileName

pub enum RealFileName {
    LocalPath(PathBuf),
    Remapped {
        local_path: Option<PathBuf>,
        virtual_name: PathBuf,
    },
}

Variants

LocalPath(PathBuf)

Remapped

For remapped paths (namely paths into libstd that have been mapped to the appropriate spot on the local host’s file system, and local file system paths that have been remapped with FilePathMapping),

Fields

local_path: Option<PathBuf>

local_path is the (host-dependent) local path to the file. This is None if the file was imported from another crate

virtual_name: PathBuf

virtual_name is the stable path rustc will store internally within build artifacts.

Implementations

impl RealFileName

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. Avoid embedding this in build artifacts; see remapped_path_if_available() for that.

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.

pub fn remapped_path_if_available(&self) -> &Path

Returns the path suitable for embedding into build artifacts. This would still be a local path if it has not been remapped. A remapped path will not correspond to a valid file system path: see local_path_if_available() for something that is more likely to return paths into the local host file system.

pub fn local_path_if_available(&self) -> &Path

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

pub fn to_path(&self, display_pref: FileNameDisplayPreference) -> &Path

Return the path remmapped or not depending on the FileNameDisplayPreference.

For the purpose of this function, local and short preference are equal.

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

Trait Implementations

impl Clone for RealFileName

fn clone(&self) -> RealFileName

Returns a copy 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<S: Encoder> Encodable<S> for RealFileName

fn encode(&self, encoder: &mut S)

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 + PartialOrd,

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

Size for each variant:

• LocalPath: 32 bytes
• Remapped: 48 bytes