Struct fclones::path::Path

pub struct Path { /* fields omitted */ }

Memory-efficient file path representation.

When storing multiple paths with common parent, the standard std::path::PathBuf would keep the parent path text duplicated in memory, wasting a lot of memory. This structure here shares the common parent between many paths by reference-counted references.

Implementations

impl Path

pub fn canonicalize(&self) -> Path

pub fn is_absolute(&self) -> bool

pub fn is_relative(&self) -> bool

pub fn share(self) -> Arc<Self>

Moves this Path under an Arc. You need to wrap Path before joining anything to it.

pub fn unshare(self: &Arc<Path>) -> Path

Copies this path from under an Arc. Generally cheap, because only the last component is copied.

pub fn join<P: AsRef<Path>>(self: &Arc<Path>, path: P) -> Path

Creates an owned Path with path adjoined to self. The path must be relative.

pub fn file_name(&self) -> Option<OsString>

Returns the name of the last component of this path or None if the path is directory (e.g. root dir or parent dir).

pub fn file_name_cstr(&self) -> Option<&CStr>

Returns the name of the last component of this path or None if the path is directory (e.g. root dir or parent dir). Doesn’t allocate anything on the heap.

pub fn parent(&self) -> Option<&Arc<Path>>

Returns the parent directory of this path. Doesn’t allocate anything on the heap.

pub fn strip_prefix(&self, base: &Path) -> Option<Path>

Returns a path that joined to base would give this path. If base is the same as this path, returns current directory. If this path doesn’t have a base prefix, returns None.

pub fn is_prefix_of(&self, other: &Path) -> bool

Returns true if self is a prefix of another path

pub fn to_path_buf(&self) -> PathBuf

Converts this path to a standard library path buffer. We need this to be able to use this path with other standard library I/O functions.

pub fn to_string_lossy(&self) -> String

Converts this path to an UTF encoded string. Any non-Unicode sequences are replaced with [U+FFFD REPLACEMENT CHARACTER][U+FFFD].

pub fn display(&self) -> &Self

pub fn hash128(&self) -> u128

Returns a hash of the full path. Useful for deduplicating paths without making path clones. We need 128-bits so that collisions are not a problem. Thanks to using a long hash we can be sure collisions won’t be a problem.

pub fn component_count(&self) -> usize

Returns the number of components in this path

pub fn root(&self) -> &Path

Returns the first component of this path

pub fn shell_quote(&self) -> String

Trait Implementations

impl AsRef<Path> for Path

fn as_ref(&self) -> &Path

Performs the conversion.

impl Clone for Path

fn clone(&self) -> Path

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Path

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

Formats the value using the given formatter.

impl Display for Path

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

Formats the value using the given formatter.

impl From<&'_ Path> for Path

fn from(p: &Path) -> Self

Performs the conversion.

impl From<&'_ PathBuf> for Path

fn from(p: &PathBuf) -> Self

Performs the conversion.

impl From<&'_ str> for Path

fn from(s: &str) -> Self

Performs the conversion.

impl From<OsString> for Path

fn from(s: OsString) -> Self

Performs the conversion.

impl From<PathBuf> for Path

fn from(p: PathBuf) -> Self

Performs the conversion.

impl From<String> for Path

fn from(s: String) -> Self

Performs the conversion.

impl Hash for Path

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, 

Feeds a slice of this type into the given Hasher.

impl Ord for Path

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

This method returns an Ordering between self and other.

#[must_use]

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Path> for Path

fn eq(&self, other: &Path) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Path) -> bool

This method tests for !=.

impl PartialOrd<Path> for Path

fn partial_cmp(&self, other: &Path) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Path

fn serialize<S>(
    &self,
    serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl Eq for Path

impl StructuralEq for Path

impl StructuralPartialEq for Path