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>

Construct an absolute path from an arbitrary (absolute or relative) one.

This is different from canonicalize in that it preserves symlinks and the destination may or may not exist.

This function will:

• Resolve relative paths against the current working directory.
• 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.

Examples

use path_abs::{PathAbs, PathInfo};

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

assert_eq!(lib.is_absolute(), true);

pub fn new_unchecked<P: Into<Arc<PathBuf>>>(path: P) -> PathAbs

Create a PathAbs unchecked.

This is mostly used for constructing during tests, or if the path was previously validated. This is effectively the same as a Arc<PathBuf>.

Note: This is memory safe, so is not marked unsafe. However, it could cause panics in some methods if the path was not properly validated.

pub fn as_path(&self) -> &Path

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

Trait Implementations

impl PathMut for PathAbs

fn append<P: AsRef<Path>>(&mut self, path: P) -> Result<()>

Appends path to this path.

fn pop_up(&mut self) -> Result<()>

Go "up" one directory.

fn truncate_to_root(&mut self)

Removes all components after the root, if any.

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

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

impl PathOps for PathAbs

type Output = PathAbs

fn concat<P: AsRef<Path>>(&self, path: P) -> Result<Self::Output>

Returns a new value representing the concatenation of two paths.

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

An exact replica of std::path::Path::join with all of its gotchas and pitfalls,, except returns a more relevant type.

fn with_file_name<S: AsRef<OsStr>>(&self, file_name: S) -> Self::Output

Creates a new path object like self but with the given file name.

fn with_extension<S: AsRef<OsStr>>(&self, extension: S) -> Self::Output

Creates a new path object like self but with the given extension.

impl From<PathAbs> for Arc<PathBuf>

fn from(path: PathAbs) -> Arc<PathBuf>

Performs the conversion.

impl From<PathAbs> for PathBuf

fn from(path: PathAbs) -> PathBuf

Performs the conversion.

impl From<PathDir> for PathAbs

fn from(path: PathDir) -> PathAbs

Performs the conversion.

impl From<PathFile> for PathAbs

fn from(path: PathFile) -> PathAbs

Performs the conversion.

impl From<PathType> for PathAbs

fn from(path: PathType) -> PathAbs

Performs the conversion.

impl PartialEq<PathAbs> for PathAbs

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

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

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

This method tests for !=.

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

fn as_ref(&self) -> &OsStr

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

fn as_ref(&self) -> &PathAbs

Performs the conversion.

impl AsRef<PathAbs> for PathFile

fn as_ref(&self) -> &PathAbs

Performs the conversion.

impl AsRef<PathAbs> for PathType

fn as_ref(&self) -> &PathAbs

Performs the conversion.

impl PartialOrd<PathAbs> for PathAbs

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

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

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

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

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

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

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

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

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

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

impl Eq for PathAbs

impl Ord for PathAbs

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

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

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

Restrict a value to a certain interval.

impl Debug for PathAbs

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

Formats the value using the given formatter.

impl Hash for PathAbs

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