Struct path_abs::PathDir

pub struct PathDir(_);

A PathAbs that is guaranteed to be a directory, with associated methods.

Implementations

impl PathDir

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

Instantiate a new PathDir. The directory must exist or io::Error will be returned.

Returns io::ErrorKind::InvalidInput if the path exists but is not a directory.

Examples

use path_abs::PathDir;

let src = PathDir::new("src")?;

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

Create a PathDir 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 current_dir() -> Result<PathDir>

Returns the current working directory from the env as a PathDir.

Examples

use path_abs::PathDir;
let cwd = PathDir::current_dir()?;

pub fn try_from<P: Into<PathAbs>>(path: P) -> Result<PathDir>

Consume the PathAbs validating that the path is a directory and returning PathDir. The directory must exist or io::Error will be returned.

If the path is actually a file returns io::ErrorKind::InvalidInput.

Examples

use path_abs::{PathAbs, PathDir};

let src_abs = PathAbs::new("src")?;
let src_dir = PathDir::try_from(src_abs)?;

pub fn create<P: AsRef<Path>>(path: P) -> Result<PathDir>

Instantiate a new PathDir to a directory, creating the directory if it doesn't exist.

Examples

use path_abs::PathDir;

let example = "example";

let dir = PathDir::create(example)?;

// It can be done twice with no effect.
let _ = PathDir::create(example)?;

pub fn create_all<P: AsRef<Path>>(path: P) -> Result<PathDir>

Instantiate a new PathDir to a directory, recursively recreating it and all of its parent components if they are missing.

Examples

use path_abs::PathDir;

let example = "example/long/path";

let path = PathDir::create_all(example)?;

// It can be done twice with no effect.
let _ = PathDir::create_all(example)?;

pub fn join_abs<P: AsRef<Path>>(&self, path: P) -> Result<PathType>

Join a path onto the PathDir, expecting it to exist. Returns the resulting PathType.

Examples

use path_abs::{PathDir, PathFile, PathInfo};

let src = PathDir::new("src")?;
let lib = src.join_abs("lib.rs")?.unwrap_file();
assert!(lib.is_file());

pub fn list(&self) -> Result<ListDir>

List the contents of the directory, returning an iterator of PathTypes.

Examples

use std::collections::HashSet;
use path_abs::{PathDir, PathFile, PathType, PathOps};

let example = "example";

let example_dir = PathDir::create(example)?;
let foo_dir = PathDir::create(example_dir.concat("foo")?)?;
let bar_file = PathFile::create(example_dir.concat("bar.txt")?)?;

let mut result = HashSet::new();
for p in example_dir.list()? {
    result.insert(p?);
}

let mut expected = HashSet::new();
expected.insert(PathType::Dir(foo_dir));
expected.insert(PathType::File(bar_file));

assert_eq!(expected, result);

pub fn remove(self) -> Result<()>

Remove (delete) the empty directory from the filesystem, consuming self.

Examples

use std::path::Path;
use path_abs::PathDir;

let example = Path::new("example/long/path");

let dir = PathDir::create_all(example)?;
let parent = dir.parent_dir().unwrap();

assert!(example.exists());
dir.remove()?;
// assert!(dir.exists());  <--- COMPILE ERROR
assert!(!example.exists());
parent.remove()?;

pub fn remove_all(self) -> Result<()>

Remove (delete) the directory, after recursively removing its contents. Use carefully!

Examples

use std::path::Path;
use path_abs::PathDir;

let example = Path::new("example/long/path");

let dir = PathDir::create_all(example)?;
let parent = dir.parent_dir().unwrap();

assert!(example.exists());
parent.remove_all()?;
assert!(!example.exists());

pub fn symlink<P: AsRef<Path>>(&self, dst: P) -> Result<PathDir>

Creates a new symbolic link on the filesystem to the dst.

This handles platform specific behavior correctly.

Examples

use path_abs::{PathDir, PathFile, PathOps};
use std::path::Path;

let example = "example";
let example_sym = "example_sym";
let dir = PathDir::create(example)?;
let file = PathFile::create(dir.concat("example.txt")?)?;

let dir_sym = dir.symlink(example_sym)?;

// They have a different "absolute path"
assert_ne!(dir, dir_sym);

// But they can be canonicalized to the same file.
let dir_can = dir_sym.canonicalize()?;
assert_eq!(dir, dir_can);

pub fn as_path(&self) -> &Path

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

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

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

See PathAbs::canonicalize

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

Get the parent directory of this directory 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;

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

Trait Implementations

impl AsRef<OsStr> for PathDir

fn as_ref(&self) -> &OsStr

Performs the conversion.

impl AsRef<Path> for PathDir

fn as_ref(&self) -> &Path

Performs the conversion.

impl AsRef<PathAbs> for PathDir

fn as_ref(&self) -> &PathAbs

Performs the conversion.

impl AsRef<PathBuf> for PathDir

fn as_ref(&self) -> &PathBuf

Performs the conversion.

impl Borrow<Path> for PathDir

fn borrow(&self) -> &Path

Immutably borrows from an owned value.

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

fn borrow(&self) -> &Path

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<PathBuf> for PathDir

fn borrow(&self) -> &PathBuf

Immutably borrows from an owned value.

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

fn borrow(&self) -> &PathBuf

Immutably borrows from an owned value.

impl Clone for PathDir

fn clone(&self) -> PathDir

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PathDir

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PathDir

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

Deserialize this value from the given Serde deserializer.

impl Eq for PathDir

impl From<PathDir> for PathAbs

fn from(path: PathDir) -> PathAbs

Performs the conversion.

impl Hash for PathDir

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

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for PathDir

fn cmp(&self, other: &PathDir) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<PathDir> for PathDir

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

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

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

This method tests for !=.

impl PartialOrd<PathDir> for PathDir

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

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

impl PathOps for PathDir

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

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

Serialize this value into the given Serde serializer.

impl StructuralEq for PathDir

impl StructuralPartialEq for PathDir