Struct path_abs::PathDir

pub struct PathDir(_);

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

Methods

impl PathDir

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

fn from_abs(abs: PathAbs) -> 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.

This does not call Path::cannonicalize(), instead trusting that the input is already a fully qualified path.

Examples

use path_abs::{PathAbs, PathDir};

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

fn from_abs_unchecked(abs: PathAbs) -> PathDir

Do the conversion without checking.

This is typically used by external libraries when the type is already known through some other means (to avoid a syscall).

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

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

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};

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

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

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

Warning: because PathAbs is the canonicalized path, symlinks are always resolved. This means that if the directory contains a symlink you may get a path from a completely different directory.

Examples

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

let example = "example";

let example_dir = PathDir::create(example)?;
let foo_dir = PathDir::create(example_dir.join("foo"))?;
let bar_file = PathFile::create(example_dir.join("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);

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

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

fn as_path(&self) -> &Path

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

fn mock<P: AsRef<Path>>(path: P) -> PathDir

Create a mock dir type. For use in tests only.

See the docs for PathAbs::mock

Methods from Deref<Target = PathAbs>

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

Trait Implementations

impl Clone for PathDir

fn clone(&self) -> PathDir

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Eq for PathDir

impl Hash for PathDir

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 PathDir

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

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

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

This method tests for !=.

impl PartialOrd for PathDir

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

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

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

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

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

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

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

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

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

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

impl Ord for PathDir

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

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

Formats the value using the given formatter.

impl AsRef<PathAbs> for PathDir

fn as_ref(&self) -> &PathAbs

Performs the conversion.

impl AsRef<Path> for PathDir

fn as_ref(&self) -> &Path

Performs the conversion.

impl AsRef<PathBuf> for PathDir

fn as_ref(&self) -> &PathBuf

Performs the conversion.

impl Deref for PathDir

type Target = PathAbs

The resulting type after dereferencing.

fn deref(&self) -> &PathAbs

Dereferences the 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 Into<PathArc> for PathDir

fn into(self) -> PathArc

Downgrades the PathDir into a PathArc

impl Into<PathBuf> for PathDir

fn into(self) -> PathBuf

Downgrades the PathDir into a PathBuf. Avoids a clone if this is the only reference.

Examples

use path_abs::PathDir;
use std::path::PathBuf;

let dir = PathDir::new("src")?;
let buf: PathBuf = dir.into();

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