Struct VirtualPathBuf 

pub struct VirtualPathBuf { /* private fields */ }

Similar to the distinction with Path and PathBuf, this is a VirtualPath that owns the underlying data.

Implementations

impl VirtualPathBuf

pub fn root() -> Self

pub fn new(path: &str) -> Result<Self, VirtualPathError>

pub fn push(&mut self, value: &str)

Extend a path with a new segment

Methods from Deref<Target = VirtualPath>

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<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 Clone for VirtualPathBuf

fn clone(&self) -> VirtualPathBuf

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VirtualPathBuf

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

Formats the value using the given formatter.

impl Deref for VirtualPathBuf

type Target = VirtualPath

The resulting type after dereferencing.

fn deref(&self) -> &VirtualPath

Dereferences the value.

impl<'de> Deserialize<'de> for VirtualPathBuf

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for VirtualPathBuf

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 VirtualPathBuf

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

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 PartialOrd for VirtualPathBuf

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for VirtualPathBuf

impl StructuralPartialEq for VirtualPathBuf