Enum path_abs::PathType

pub enum PathType {
    File(PathFile),
    Dir(PathDir),
}

An an enum containing either a file or a directory.

This is used primarily for: - The items returned from PathDir::list - Serializing paths of different types.

Note: symlinks are not supported because they are impossible for canonicalized paths.

Variants

File(PathFile)Dir(PathDir)

Methods

impl PathType

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

Resolves and returns the PathType of the given path.

If the path exists but is not a file or a directory (i.e. is a symlink), then io::ErrorKind::InvalidInput is returned.

Examples

use path_abs::PathType;

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

fn from_abs(abs: PathAbs) -> Result<PathType>

Consume the PathAbs returning the PathType.

fn unwrap_file(self) -> PathFile

Unwrap the PathType as a PathFile.

Examples

use path_abs::PathType;

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

fn unwrap_dir(self) -> PathDir

Unwrap the PathType as a PathDir.

Examples

use path_abs::PathType;

let src = PathType::new("src")?.unwrap_dir();

fn is_dir(&self) -> bool

Return whether this variant is PathType::Dir.

fn is_file(&self) -> bool

Return whether this variant is PathType::File.

fn mock_file<P: AsRef<Path>>(path: P) -> PathType

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

See the docs for PathAbs::mock

fn mock_dir<P: AsRef<Path>>(path: P) -> PathType

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 Debug for PathType

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

Formats the value using the given formatter.

impl Clone for PathType

fn clone(&self) -> PathType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Eq for PathType

impl Hash for PathType

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 PathType

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

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

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

This method tests for !=.

impl PartialOrd for PathType

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

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

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

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

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

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

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

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

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

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

impl Ord for PathType

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

fn as_ref(&self) -> &PathAbs

Performs the conversion.

impl AsRef<PathArc> for PathType

fn as_ref(&self) -> &PathArc

Performs the conversion.

impl AsRef<Path> for PathType

fn as_ref(&self) -> &Path

Performs the conversion.

impl AsRef<PathBuf> for PathType

fn as_ref(&self) -> &PathBuf

Performs the conversion.

impl Deref for PathType

type Target = PathAbs

The resulting type after dereferencing.

fn deref(&self) -> &PathAbs

Dereferences the value.

impl Borrow<PathAbs> for PathType

fn borrow(&self) -> &PathAbs

Immutably borrows from an owned value.

impl Borrow<PathArc> for PathType

fn borrow(&self) -> &PathArc

Immutably borrows from an owned value.

impl Borrow<Path> for PathType

fn borrow(&self) -> &Path

Immutably borrows from an owned value.

impl Borrow<PathBuf> for PathType

fn borrow(&self) -> &PathBuf

Immutably borrows from an owned value.

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

fn borrow(&self) -> &PathAbs

Immutably borrows from an owned value.

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

fn borrow(&self) -> &PathArc

Immutably borrows from an owned value.

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

fn borrow(&self) -> &Path

Immutably borrows from an owned value.

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

fn borrow(&self) -> &PathBuf

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

impl Into<PathArc> for PathType

fn into(self) -> PathArc

Downgrades the PathType into a PathArc

impl Into<PathBuf> for PathType

fn into(self) -> PathBuf

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

Examples

use path_abs::PathType;
use std::path::PathBuf;

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