Struct VfsPath

pub struct VfsPath(/* private fields */);

Path in Vfs.

Long-term, we want to support files which do not reside in the file-system, so we treat VfsPaths as opaque identifiers.

Implementations

impl VfsPath

pub fn new_virtual_path(path: String) -> VfsPath

Creates an “in-memory” path from /-separated string.

This is most useful for testing, to avoid windows/linux differences

Panics

Panics if path does not start with '/'.

pub fn new_real_path(path: String) -> VfsPath

Create a path from string. Input should be a string representation of an absolute path inside filesystem

pub fn as_path(&self) -> Option<&AbsPath>

Returns the AbsPath representation of self if self is on the file system.

pub fn into_abs_path(self) -> Option<AbsPathBuf>

pub fn join(&self, path: &str) -> Option<VfsPath>

Creates a new VfsPath with path adjoined to self.

pub fn pop(&mut self) -> bool

Remove the last component of self if there is one.

If self has no component, returns false; else returns true.

Example

let mut path = VfsPath::from(AbsPathBuf::assert("/foo/bar".into()));
assert!(path.pop());
assert_eq!(path, VfsPath::from(AbsPathBuf::assert("/foo".into())));
assert!(path.pop());
assert_eq!(path, VfsPath::from(AbsPathBuf::assert("/".into())));
assert!(!path.pop());

pub fn starts_with(&self, other: &VfsPath) -> bool

Returns true if other is a prefix of self.

pub fn strip_prefix(&self, other: &VfsPath) -> Option<&RelPath>

pub fn parent(&self) -> Option<VfsPath>

Returns the VfsPath without its final component, if there is one.

Returns None if the path is a root or prefix.

pub fn name_and_extension(&self) -> Option<(&str, Option<&str>)>

Returns self’s base name and file extension.

Trait Implementations

impl Clone for VfsPath

fn clone(&self) -> VfsPath

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VfsPath

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

Formats the value using the given formatter.

impl Display for VfsPath

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

Formats the value using the given formatter.

impl From<AbsPathBuf> for VfsPath

fn from(v: AbsPathBuf) -> VfsPath

Converts to this type from the input type.

impl Hash for VfsPath

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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 VfsPath

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

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

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

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

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

impl StructuralPartialEq for VfsPath