filey 1.4.0

A collection of utilities to make file operations more convenient.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56

use serde::{Deserialize, Serialize};
use std::{fmt, path::Path};

#[derive(PartialEq, Eq, PartialOrd, Ord, Clone, Copy, Debug, Serialize, Deserialize, Hash)]
pub enum FileTypes {
    File,
    Directory,
    Symlink,
}

impl fmt::Display for FileTypes {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match self {
            Self::File => write!(f, "file"),
            Self::Directory => write!(f, "directory"),
            Self::Symlink => write!(f, "symlink"),
        }
    }
}

impl FileTypes {
    /// Detects the type of a file.
    /// If the file doesn't exist, returns None.
    ///
    /// # Examples
    /// ```
    /// # use filey::FileTypes;
    /// #
    /// # fn kind() -> Option<()> {
    /// let file = "src/lib.rs";
    /// println!(FileTypes::which(file)?); // file
    ///
    /// let directory = "src";
    /// println!(FileTypes::which(directory)?); // directory
    /// # Some(())
    /// # }
    /// # fn main() {
    /// # kind().unwrap();
    /// # }
    /// ```
    pub fn which<P: AsRef<Path>>(path: P) -> Option<Self> {
        let path = path.as_ref();

        if path.is_symlink() {
            Some(Self::Symlink)
        } else if path.exists() {
            if path.is_dir() {
                Some(Self::Directory)
            } else {
                Some(Self::File)
            }
        } else {
            None
        }
    }
}