Struct path_abs::PathAbs

pub struct PathAbs(_);

An absolute (not necessarily canonicalized) path that may or may not exist.

Methods

impl PathAbs

pub 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")?;

pub fn into_file(self) -> Result<PathFile>

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

pub fn into_dir(self) -> Result<PathDir>

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

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

pub fn as_path(&self) -> &Path

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

pub 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>

pub 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

pub 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

pub 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

pub 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

pub 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

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

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>

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>

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>

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.

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 AsRef<Path> for PathAbs

fn as_ref(&self) -> &Path

Performs the conversion.

impl AsRef<PathBuf> for PathAbs

fn as_ref(&self) -> &PathBuf

Performs the conversion.

impl Borrow<PathArc> for PathAbs

fn borrow(&self) -> &PathArc

Immutably borrows from an owned value.

impl Borrow<Path> for PathAbs

fn borrow(&self) -> &Path

Immutably borrows from an owned value.

impl Borrow<PathBuf> for PathAbs

fn borrow(&self) -> &PathBuf

Immutably borrows from an owned value.

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

fn borrow(&self) -> &PathArc

Immutably borrows from an owned value.

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

fn borrow(&self) -> &Path

Immutably borrows from an owned value.

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

fn borrow(&self) -> &PathBuf

Immutably borrows from an owned value.

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 AsRef<PathAbs> for PathDir

fn as_ref(&self) -> &PathAbs

Performs the conversion.

impl Borrow<PathAbs> for PathDir

fn borrow(&self) -> &PathAbs

Immutably borrows from an owned value.

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

fn borrow(&self) -> &PathAbs

Immutably borrows from an owned value.

impl Into<PathAbs> for PathDir

fn into(self) -> PathAbs

Downgrades the PathDir into a PathAbs

Examples

use std::path::PathBuf;
use path_abs::{PathDir, PathAbs};

let dir = PathDir::new("src")?;
let abs: PathAbs = dir.into();

impl AsRef<PathAbs> for PathFile

fn as_ref(&self) -> &PathAbs

Performs the conversion.

impl Borrow<PathAbs> for PathFile

fn borrow(&self) -> &PathAbs

Immutably borrows from an owned value.

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

fn borrow(&self) -> &PathAbs

Immutably borrows from an owned value.

impl Into<PathAbs> for PathFile

fn into(self) -> PathAbs

Downgrades the PathFile into a PathAbs

Examples

use std::path::PathBuf;
use path_abs::{PathFile, PathAbs};

let file = PathFile::new("src/lib.rs")?;
let abs: PathAbs = file.clone().into();

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.

impl AsRef<PathAbs> for PathType

fn as_ref(&self) -> &PathAbs

Performs the conversion.

impl Borrow<PathAbs> for PathType

fn borrow(&self) -> &PathAbs

Immutably borrows from an owned value.

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

fn borrow(&self) -> &PathAbs

Immutably borrows from an owned value.

impl Into<PathAbs> for PathType

fn into(self) -> PathAbs

Downgrades the PathType into a PathAbs

Examples

use std::path::PathBuf;
use path_abs::{PathType, PathAbs};

let ty = PathType::new("src/lib.rs")?;
let abs: PathAbs = ty.into();