Enum FileName 

pub enum FileName {
    Real(PathBuf),
    Virtual(Cow<'static, str>),
}

A FileName represents the name of a logical source code file, while retaining some context about whether that file is a real file on disk, or a “virtual” file, i.e. only exists in memory.

Variants

Real(PathBuf)

A real file on disk

Virtual(Cow<'static, str>)

A synthetic file, eg. from the REPL

Implementations

impl FileName

pub fn real<T: Into<PathBuf>>(name: T) -> FileName

Creates a new FileName that is intended to represent a real file on disk.

pub fn virtual_<T: Into<Cow<'static, str>>>(name: T) -> FileName

Creates a new FileName that is intended to represent a virtual file in memory.

pub fn is_dir(&self) -> bool

Returns true if this filename represents a real directory on disk

pub fn is_file(&self) -> bool

Returns true if this filename represents a real file on disk

pub fn as_str(&self) -> Option<&str>

Tries to return this filename as a &str, avoiding any allocations

This will only return None if the filename is a path which requires lossy conversion to unicode. See to_string if you want an infallible conversion to a Rust string, albeit at the cost of an allocation

Trait Implementations

impl AsRef<Path> for FileName

fn as_ref(&self) -> &Path

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for FileName

fn clone(&self) -> FileName

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileName

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

Formats the value using the given formatter.

impl Display for FileName

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

Formats the value using the given formatter.

impl<'a> From<&'a FileName> for &'a Path

fn from(name: &'a FileName) -> &'a Path

Converts to this type from the input type.

impl<'a> From<&'a Path> for FileName

fn from(name: &Path) -> FileName

Converts to this type from the input type.

impl From<&'static str> for FileName

fn from(name: &'static str) -> FileName

Converts to this type from the input type.

impl From<FileName> for PathBuf

fn from(name: FileName) -> PathBuf

Converts to this type from the input type.

impl From<PathBuf> for FileName

fn from(name: PathBuf) -> FileName

Converts to this type from the input type.

impl From<String> for FileName

fn from(name: String) -> FileName

Converts to this type from the input type.

impl Hash for FileName

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 FileName

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

fn eq(&self, other: &Path) -> 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 PartialEq<PathBuf> for FileName

fn eq(&self, other: &PathBuf) -> 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 PartialEq for FileName

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

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

impl StructuralPartialEq for FileName