Struct Path 

pub struct Path { /* private fields */ }

Memory-efficient file path representation.

When storing multiple paths with common parent, the standard 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 root(&self) -> Option<&Path>

Returns the absolute root of the path if the path is absolute. In Unix, returns “/”. In Windows this can return a root with prefix e.g. “C:". If path is relative, returns None.

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 resolve<P: AsRef<Path>>(self: &Arc<Path>, path: P) -> Path

If path is relative, works the same as join. If path is absolute, ignores self and returns path.

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 strip_root(&self) -> Path

If this path is absolute, strips the root component and returns a relative path. Otherwise returns a clone of this path. E.g. /foo/bar becomes foo/bar

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 to_escaped_string(&self) -> String

Returns a lossless string representation in STFU8 format.

pub fn from_escaped_string(encoded: &str) -> Result<Path, DecodeError>

Decodes the path from the string encoded with to_escaped_string.

pub fn quote(&self) -> String

Formats the path in a way that Posix-shell can decode it. If the path doesn’t contain any special characters, returns it as-is. If the path contains special shell characters like ‘\’ or ‘*’, it is single-quoted. This function also takes care of the characters that cannot be represented in UTF-8 by escaping them with $'\xXX' or $'\uXXXX' syntax.

pub fn display(&self) -> String

Returns a representation suitable for display in the console. Control characters like newline or linefeed are escaped.

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

Trait Implementations

impl AsRef<Path> for FileInfo

fn as_ref(&self) -> &Path

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

impl AsRef<Path> for Path

fn as_ref(&self) -> &Path

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

impl AsRef<Path> for PathAndMetadata

fn as_ref(&self) -> &Path

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

impl Clone for Path

fn clone(&self) -> Path

Returns a duplicate 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 Default for Path

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Path

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<FileInfo> for Path

fn from(info: FileInfo) -> Self

Converts to this type from the input type.

impl<P> From<P> for Path

where P: AsRef<Path>,

fn from(p: P) -> Self

Converts to this type from the input type.

impl From<PathAndMetadata> for Path

fn from(value: PathAndMetadata) -> Self

Converts to this type from the input type.

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, Self: Sized,

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.

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 for Path

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

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

Allows to read command line arguments as crate::path::Path.

type Parser = PathParser

Generated parser, usually ValueParser.

fn value_parser() -> Self::Parser

Create the specified Self::Parser

impl Eq for Path

impl StructuralPartialEq for Path