Struct ergo_fs::PathArc

pub struct PathArc(_);

A PathBuf that is atomically reference counted and reimplements the PathBuf methods to display the action and path when there is an error.

This is the root type of all other Path* types in this crate.

This type is also serializable when the serialize feature is enabled.

Methods

impl PathArc

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

Instantiate a new PathArc.

Examples

use path_abs::PathArc;

let path = PathArc::new("some/path");
let path2 = path.clone(); // cloning is cheap

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

Creates an owned PathBuf with path adjoined to self.

This function is identical to std::path::PathBuf::join except it returns PathArc instead of PathBuf

pub fn with_file_name<P>(&self, file_name: P) -> PathArc where
    P: AsRef<OsStr>, 

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

This function is identical to std::path::PathBuf::with_file_name except it returns PathArc instead of PathBuf

pub fn with_extension<P>(&self, extension: P) -> PathArc where
    P: AsRef<OsStr>, 

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

This function is identical to std::path::PathBuf::with_extension except it returns PathArc instead of PathBuf

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

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

This function will traverse symbolic links to query information about the destination file.

This function is identical to std::path::Path::metadata except it has error messages which include the action and the path

pub fn symlink_metadata(&self) -> Result<Metadata, Error>

Queries the metadata about a file without following symlinks.

This function is identical to std::path::Path::symlink_metadata except it has error messages which include the action and the path

pub fn canonicalize(&self) -> Result<PathAbs, Error>

Returns the canonical form of the path with all intermediate components normalized and symbolic links resolved.

This function is identical to std::path::Path::canonicalize except:

• It returns a PathAbs object
• It has error messages which include the action and the path

pub fn read_link(&self) -> Result<PathArc, Error>

Reads a symbolic link, returning the file that the link points to.

This function is identical to std::path::Path::read_link except:

• It returns a PathArc object instead of PathBuf
• It has error messages which include the action and the path

pub fn read_dir(&self) -> Result<ListDir, Error>

Returns an iterator over the entries within a directory.

This function is a shortcut to PathDir::list. It is slightly different than std::path::Path::read_dir.

pub fn as_path(&self) -> &Path

Return a reference to a basic std::path::Path

pub fn absolute(&self) -> Result<PathAbs, Error>

Convert the path to an absolute one, this is different from canonicalize in that it preserves symlinks and the destination may or may not exist.

This function will:

• Use current_dir to resolve relative paths.
• Strip any . components (/a/./c -> /a/c)
• Resolve .. semantically (not using the file system). So, a/b/c/../d => a/b/d will always be true regardless of symlinks. If you want symlinks correctly resolved, use canonicalize() instead.

On windows, this will sometimes call canonicalize() on the first component to guarantee it is the correct canonicalized prefix. For paths starting with root it also has to get the current_dir

On linux, the only syscall this will make is to get the current_dir for relative paths.

impl PathArc

pub fn to_string(&self) -> String

Convert the PathArc into an STFU8 String.

pub fn from_str(s: &str) -> Result<PathArc, DecodeError>

Convert STFU8 str to a PathArc.

Methods from Deref<Target = PathBuf>

pub fn as_path(&self) -> &Path

Coerces to a Path slice.

Examples

use std::path::{Path, PathBuf};

let p = PathBuf::from("/test");
assert_eq!(Path::new("/test"), p.as_path());

Trait Implementations

impl Ord for PathArc

fn cmp(&self, __arg_0: &PathArc) -> 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.

impl AsRef<PathArc> for PathAbs

fn as_ref(&self) -> &PathArc

Performs the conversion.

impl AsRef<PathArc> for PathDir

fn as_ref(&self) -> &PathArc

Performs the conversion.

impl AsRef<Path> for PathArc

fn as_ref(&self) -> &Path

Performs the conversion.

impl AsRef<PathArc> for PathType

fn as_ref(&self) -> &PathArc

Performs the conversion.

impl AsRef<PathBuf> for PathArc

fn as_ref(&self) -> &PathBuf

Performs the conversion.

impl AsRef<PathArc> for PathFile

fn as_ref(&self) -> &PathArc

Performs the conversion.

impl PartialOrd<PathArc> for PathArc

fn partial_cmp(&self, __arg_0: &PathArc) -> Option<Ordering>

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

fn lt(&self, __arg_0: &PathArc) -> bool

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

fn le(&self, __arg_0: &PathArc) -> bool

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

fn gt(&self, __arg_0: &PathArc) -> bool

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

fn ge(&self, __arg_0: &PathArc) -> bool

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

impl Deref for PathArc

type Target = PathBuf

The resulting type after dereferencing.

fn deref(&self) -> &PathBuf

Dereferences the value.

impl Into<PathArc> for PathType

fn into(self) -> PathArc

Downgrades the PathType into a PathArc

impl Into<PathBuf> for PathArc

fn into(self) -> PathBuf

If there is only one reference to the PathArc, returns the inner PathBuf. Otherwise clones the inner PathBuf.

This is useful when you really want a PathBuf, especially when the PathArc was only recently created.

Examples

use path_abs::PathArc;
use std::path::PathBuf;

let base = PathArc::new("base");
let foo: PathBuf = base.join("foo.txt").into();

impl Into<PathArc> for PathAbs

fn into(self) -> PathArc

Performs the conversion.

impl Into<PathArc> for PathFile

fn into(self) -> PathArc

Downgrades the PathFile into a PathArc

impl Into<PathArc> for PathDir

fn into(self) -> PathArc

Downgrades the PathDir into a PathArc

impl<'de> Deserialize<'de> for PathArc

fn deserialize<D>(
    deserializer: D
) -> Result<PathArc, <D as Deserializer<'de>>::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Eq for PathArc

impl Hash for PathArc

fn hash<__H>(&self, __arg_0: &mut __H) where
    __H: Hasher, 

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 PartialEq<PathArc> for PathArc

fn eq(&self, __arg_0: &PathArc) -> bool

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

fn ne(&self, __arg_0: &PathArc) -> bool

This method tests for !=.

impl Borrow<PathBuf> for PathArc

fn borrow(&self) -> &PathBuf

Immutably borrows from an owned value.

impl Borrow<PathArc> for PathAbs

fn borrow(&self) -> &PathArc

Immutably borrows from an owned value.

impl Borrow<Path> for PathArc

fn borrow(&self) -> &Path

Immutably borrows from an owned value.

impl<'a> Borrow<PathArc> for &'a PathType

fn borrow(&self) -> &PathArc

Immutably borrows from an owned value.

impl Borrow<PathArc> for PathFile

fn borrow(&self) -> &PathArc

Immutably borrows from an owned value.

impl Borrow<PathArc> for PathType

fn borrow(&self) -> &PathArc

Immutably borrows from an owned value.

impl<'a> Borrow<PathBuf> for &'a PathArc

fn borrow(&self) -> &PathBuf

Immutably borrows from an owned value.

impl Borrow<PathArc> for PathDir

fn borrow(&self) -> &PathArc

Immutably borrows from an owned value.

impl<'a> Borrow<PathArc> for &'a PathFile

fn borrow(&self) -> &PathArc

Immutably borrows from an owned value.

impl<'a> Borrow<Path> for &'a PathArc

fn borrow(&self) -> &Path

Immutably borrows from an owned value.

impl<'a> Borrow<PathArc> for &'a PathDir

fn borrow(&self) -> &PathArc

Immutably borrows from an owned value.

impl<'a> Borrow<PathArc> for &'a PathAbs

fn borrow(&self) -> &PathArc

Immutably borrows from an owned value.

impl Serialize for PathArc

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 From<PathBuf> for PathArc

fn from(path: PathBuf) -> PathArc

Instantiate a new PathArc from a PathBuf.

impl Clone for PathArc

fn clone(&self) -> PathArc

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PathArc

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

Formats the value using the given formatter.

impl Into<PathArc> for PathTmp

fn into(self) -> PathArc

Downgrades the PathTmp into a PathArc