Enum ergo_fs::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>(path: P) -> Result<PathType, Error> where
    P: AsRef<Path>, 

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, Error>

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>(path: P) -> PathType where
    P: AsRef<Path>, 

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

See the docs for PathAbs::mock

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

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

See the docs for PathAbs::mock

Trait Implementations

impl Serialize for PathType

fn serialize<__S>(
    &self,
    __serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error> where
    __S: Serializer, 

impl Ord for PathType

fn cmp(&self, __arg_0: &PathType) -> Ordering

impl Hash for PathType

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

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

fn clone(&self) -> PathType

impl Eq for PathType

impl PartialEq<PathType> for PathType

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

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

impl Debug for PathType

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PathType

fn deserialize<__D>(
    __deserializer: __D
) -> Result<PathType, <__D as Deserializer<'de>>::Error> where
    __D: Deserializer<'de>, 

impl PartialOrd<PathType> for PathType

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

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

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

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

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

impl PathTypeExt for PathType

fn from_entry(entry: DirEntry) -> Result<PathType>

Create a PathType from a walkdir::DirEntry using fewer syscalls.