Struct canonical_path::CanonicalPathBuf

pub struct CanonicalPathBuf(_);

An owned path on the filesystem which is guaranteed to be canonical.

More specifically: it is at least guaranteed to be canonical at the time it is created. There are potential TOCTTOU problems if the underlying filesystem structure changes after path canonicalization.

Methods

impl CanonicalPathBuf

pub fn canonicalize<P>(path: P) -> Result<Self> where
    P: AsRef<Path>, 

Create a canonical path by first canonicalizing the given path.

pub fn new<P>(path: P) -> Result<Self> where
    P: AsRef<Path>, 

Create a canonical path, returning error if the supplied path is not canonical.

pub fn as_canonical_path(&self) -> &CanonicalPath

Return a CanonicalPath reference.

pub fn set_file_name<S: AsRef<OsStr>>(&mut self, file_name: S)

Updates self's filename ala the same method on PathBuf

pub fn set_extension<S: AsRef<OsStr>>(&mut self, extension: S) -> bool

Updates self.extension to extension.

Returns false and does nothing if self.file_name is None, returns true and updates the extension otherwise. If self.extension is None, the extension is added; otherwise it is replaced.

pub fn into_path_buf(self) -> PathBuf

Consumes the CanonicalPathBuf, yielding its internal PathBuf storage.

pub fn into_os_string(self) -> OsString

Consumes the CanonicalPathBuf, yielding its internal OsString storage.

pub fn as_path(&self) -> &Path

Return a Path reference.

pub fn as_os_str(&self) -> &OsStr

Return an OsStr reference.

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

Yields a &str slice if the path is valid unicode.

pub fn parent(&self) -> Result<CanonicalPathBuf>

Return a canonical parent path of this path, or io::Error if the path is the root directory or another canonicalization error occurs.

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

Returns the final component of the path, if there is one.

pub fn starts_with<P: AsRef<Path>>(&self, base: P) -> bool

Determines whether base is a prefix of self.

pub fn ends_with<P: AsRef<Path>>(&self, child: P) -> bool

Determines whether child is a suffix of self.

pub fn file_stem(&self) -> Option<&OsStr>

Extracts the stem (non-extension) portion of self.file_name.

pub fn extension(&self) -> Option<&OsStr>

Extracts the extension of self.file_name, if possible.

pub fn with_file_name<S: AsRef<OsStr>>(
    &self,
    file_name: S
) -> Result<CanonicalPathBuf>

Creates an owned CanonicalPathBuf like self but with the given file name.

pub fn with_extension<S: AsRef<OsStr>>(
    &self,
    extension: S
) -> Result<CanonicalPathBuf>

Creates an owned CanonicalPathBuf like self but with the given extension.

pub fn components(&self) -> Components

Produces an iterator over the Components of a path

pub fn iter(&self) -> Iter

Produces an iterator over the path's components viewed as OsStr slices.

pub fn display(&self) -> Display

Returns an object that implements Display for safely printing paths that may contain non-Unicode data.

pub fn metadata(&self) -> Result<Metadata>

Queries the file system to get information about a file, directory, etc.

Unlike the std version of this method, it will not follow symlinks, since as a canonical path we should be symlink-free.

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

Join a path onto a canonical path, returning a CanonicalPathBuf.

pub fn read_dir(&self) -> Result<ReadDir>

Returns an iterator over the entries within a directory.

The iterator will yield instances of io::Result. New errors may be encountered after an iterator is initially constructed.

This is an alias to fs::read_dir.

pub fn exists(&self) -> bool

Does this path exist?

pub fn is_file(&self) -> bool

Is this path a file?

pub fn is_dir(&self) -> bool

Is this path a directory?

Trait Implementations

impl PartialEq<CanonicalPathBuf> for CanonicalPathBuf

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

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

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

This method tests for !=.

impl AsRef<Path> for CanonicalPathBuf

fn as_ref(&self) -> &Path

Performs the conversion.

impl AsRef<CanonicalPath> for CanonicalPathBuf

fn as_ref(&self) -> &CanonicalPath

Performs the conversion.

impl AsRef<OsStr> for CanonicalPathBuf

fn as_ref(&self) -> &OsStr

Performs the conversion.

impl Clone for CanonicalPathBuf

fn clone(&self) -> CanonicalPathBuf

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Ord for CanonicalPathBuf

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl Eq for CanonicalPathBuf

impl PartialOrd<CanonicalPathBuf> for CanonicalPathBuf

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

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

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

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

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

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

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

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

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

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

impl Debug for CanonicalPathBuf

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

Formats the value using the given formatter.

impl Hash for CanonicalPathBuf

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 Borrow<CanonicalPath> for CanonicalPathBuf

fn borrow(&self) -> &CanonicalPath

Immutably borrows from an owned value.