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

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.