Struct VirtualPath

pub struct VirtualPath { /* private fields */ }

A wrapper type that allows doing path operations on strings, without considerations for any concrete file system. These paths are supposed to be absolute and should start with a ‘/’.

Implementations

impl VirtualPath

pub const fn root() -> &'static Self

Return the root path: “/”

pub fn is_root(&self) -> bool

Check if this path represent a “root”

pub fn len(&self) -> usize

Return the number of elements in the path

pub fn is_empty(&self) -> bool

alias for Self::is_root

pub fn chroot(&self, new_root: &VirtualPath) -> Result<&Self, VirtualPathError>

Return a new VirtualPath with a new root

pub fn is_inside(&self, other: &VirtualPath) -> bool

Return true if the node pointed by “self” is contained in “other”, eventually recursively Return also true if self == other

pub fn name(&self) -> &str

Return the name of the element pointed by this path

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

Return the parent of this path, if any

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

Return the top level directory of this path, for example “a” in “/a/b/c”. Return None is the provided path is the root

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

Return the path split in two components, the top level and the rest. For example, the path “a/b/c” will return Some(“a”, “/b/c”). Return None when called on a root path.

pub fn iter(&self) -> VirtualPathIterator<'_>

Return an iterator over the components of the path

Trait Implementations

impl AsRef<Path> for VirtualPath

fn as_ref(&self) -> &Path

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

impl AsRef<VirtualPath> for VirtualPathBuf

fn as_ref(&self) -> &VirtualPath

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

impl Borrow<VirtualPath> for VirtualPathBuf

fn borrow(&self) -> &VirtualPath

Immutably borrows from an owned value.

impl Debug for VirtualPath

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

Formats the value using the given formatter.

impl<'a> From<&'a VirtualPath> for &'a str

fn from(value: &'a VirtualPath) -> Self

Converts to this type from the input type.

impl Ord for VirtualPath

fn cmp(&self, other: &VirtualPath) -> Ordering

This method returns an Ordering between self and other.

impl<'a> PartialEq<&'a VirtualPath> for VirtualPathBuf

fn eq(&self, other: &&'a VirtualPath) -> 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<VirtualPathBuf> for &VirtualPath

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

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

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

type Owned = VirtualPathBuf

The resulting type after obtaining ownership.

fn to_owned(&self) -> Self::Owned

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

Uses borrowed data to replace owned data, usually by cloning.

impl<'a> TryFrom<&'a str> for &'a VirtualPath

type Error = VirtualPathError

The type returned in the event of a conversion error.

fn try_from(value: &'a str) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for VirtualPath

impl StructuralPartialEq for VirtualPath