Struct path_abs::PathAbs

pub struct PathAbs(_);

An absolute (canonicalized) path that is guaranteed (when created) to exist.

Methods

impl PathAbs

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

Instantiate a new PathAbs. The path must exist or io::Error will be returned.

Examples

use path_abs::PathAbs;

let lib = PathAbs::new("src/lib.rs")?;

fn into_file(self) -> Result<PathFile>

Resolve the PathAbs as a PathFile. Return an error if it is not a file.

fn into_dir(self) -> Result<PathDir>

Resolve the PathAbs as a PathDir. Return an error if it is not a directory.

fn parent_dir(&self) -> Option<PathDir>

Get the parent directory of this path as a PathDir.

This does not make aditional syscalls, as the parent by definition must be a directory and exist.

Examples

use path_abs::{PathDir, PathFile};

let lib = PathFile::new("src/lib.rs")?;
let src = lib.parent_dir().unwrap();
assert_eq!(PathDir::new("src")?, src);

fn as_path(&self) -> &Path

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

fn mock<P: AsRef<Path>>(fake_path: P) -> PathAbs

For constructing mocked paths during tests. This is effectively the same as a PathBuf.

This is NOT checked for validity so the file may or may not actually exist and will NOT be, in any way, an absolute or canonicalized path.

Examples

use path_abs::PathAbs;

// this file exist
let lib = PathAbs::new("src/lib.rs")?;

let lib_mocked = PathAbs::mock("src/lib.rs");

// in this case, the mocked file exists
assert!(lib_mocked.exists());

// However, it is NOT equivalent to `lib`
assert_ne!(lib, lib_mocked);

// this file doesn't exist at all
let dne = PathAbs::mock("src/dne.rs");
assert!(!dne.exists());

Methods from Deref<Target = PathArc>

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

Trait Implementations

impl Clone for PathAbs

fn clone(&self) -> PathAbs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Eq for PathAbs

impl Hash for PathAbs

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 PathAbs

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

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

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

This method tests for !=.

impl PartialOrd for PathAbs

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

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

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

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

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

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

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

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

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

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

impl Ord for PathAbs

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

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

Formats the value using the given formatter.

impl AsRef<PathArc> for PathAbs

fn as_ref(&self) -> &PathArc

Performs the conversion.

impl Deref for PathAbs

type Target = PathArc

The resulting type after dereferencing.

fn deref(&self) -> &PathArc

Dereferences the value.

impl Into<PathArc> for PathAbs

fn into(self) -> PathArc

Performs the conversion.

impl Serialize for PathAbs

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 PathAbs

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

Deserialize this value from the given Serde deserializer.