Struct fclones::Path

source ·

pub struct Path { /* private fields */ }

Expand description

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§

source §

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.

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

source

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

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

source

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.

source

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.

source

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).

source

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.

source

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

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

source

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.

source

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

source

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

Returns true if self is a prefix of another path

source

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.

source

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].

source

pub fn to_escaped_string(&self) -> String

Returns a lossless string representation in STFU8 format.

source

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

Decodes the path from the string encoded with to_escaped_string.

source

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.

source

pub fn display(&self) -> String

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

source

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.

source