Struct path_abs::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

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

Instantiate a new PathArc.

Examples

use path_abs::PathArc;

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

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

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

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

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

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

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

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

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

fn symlink_metadata(&self) -> Result<Metadata>

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

fn canonicalize(&self) -> Result<PathAbs>

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

This is identical to PathAbs::new(path).

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

fn read_link(&self) -> Result<PathArc>

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

fn read_dir(&self) -> Result<ListDir>

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.

fn as_path(&self) -> &Path

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

Methods from Deref<Target = PathBuf>

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());

fn into_os_string(self) -> OsString

Consumes the PathBuf, yielding its internal OsString storage.

Examples

use std::path::PathBuf;

let p = PathBuf::from("/the/head");
let os_str = p.into_os_string();

fn into_boxed_path(self) -> Box<Path>

Converts this PathBuf into a boxed Path.

Trait Implementations

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

impl Hash for PathArc

fn hash<__H: Hasher>(&self, __arg_0: &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 PartialEq 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 PartialOrd 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 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 Debug for PathArc

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

Formats the value using the given formatter.

impl AsRef<PathBuf> for PathArc

fn as_ref(&self) -> &PathBuf

Performs the conversion.

impl AsRef<Path> for PathArc

fn as_ref(&self) -> &Path

Performs the conversion.

impl Deref for PathArc

type Target = PathBuf

The resulting type after dereferencing.

fn deref(&self) -> &PathBuf

Dereferences the value.

impl From<PathBuf> for PathArc

fn from(path: PathBuf) -> PathArc

Instantiate a new PathArc from a PathBuf.

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

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

Serialize this value into the given Serde serializer.

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

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

Deserialize this value from the given Serde deserializer.