pipelight_utils 0.2.9

A set of trivial utilities for command line tools
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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

//!
//! The following boolean or each mutualy exclusives.
//! A path cannot be more than one of the three alternatives.
//! It is either a filename, a relative path or an absolute path
//!

// Filesystem
use std::path::Path;
// Error Handling
use miette::{Error, Result};

/**
* Determine whether the provided path struct is a filename
*/
pub fn is_filename(path: &Path) -> Result<()> {
    if path == Path::new(path.file_name().unwrap()) {
        Ok(())
    } else {
        Err(Error::msg("The provided path isn't a filename."))
    }
}
/**
* Determine whether the provided path struct is a relative path
* Return false if the path is a filename like "my_file" and isn't prefixed with "./".
* Return true if the file path is "./my_file".

* This is a tweaked strict version of the standard Path::is_relative() method.
*/
pub fn is_relative(path: &Path) -> Result<()> {
    if path.is_relative() && self::is_filename(path).is_err() {
        Ok(())
    } else {
        Err(Error::msg("The provided path isn't a relative path."))
    }
}
/**
* Determine whether the provided path struct is an absolute path
*/
pub fn is_absolute(path: &Path) -> Result<()> {
    if path.is_absolute() {
        Ok(())
    } else {
        Err(Error::msg("The provided path isn't an absolute path."))
    }
}
#[cfg(test)]
mod tests {
    use super::*;
    use std::path::Path;

    #[test]
    fn try_is_filename() {
        let path = Path::new("test.txt");
        let res = is_filename(&path);
        assert!(res.is_ok());
    }
    #[test]
    fn try_is_not_filename_but_relative() {
        let path = Path::new("directory/test.txt");
        let res = is_filename(&path);
        assert!(res.is_err());
    }
    #[test]
    fn try_is_not_filename_but_absolute() {
        let path = Path::new("/directory/test.txt");
        let res = is_filename(&path);
        assert!(res.is_err());
    }
    #[test]
    fn try_is_relative() {
        let path = Path::new("directory/test.txt");
        let res = is_relative(&path);
        assert!(res.is_ok());
    }
    #[test]
    fn try_is_not_relative_but_filename() {
        let path = Path::new("test.txt");
        let res = is_relative(&path);
        assert!(res.is_err());
    }
    #[test]
    fn try_is_not_relative_but_absolute() {
        let path = Path::new("/directory/test.txt");
        let res = is_relative(&path);
        assert!(res.is_err());
    }
    #[test]
    fn try_is_absolute() {
        let path = Path::new("/directory/test.txt");
        let res = is_absolute(&path);
        assert!(res.is_ok());
    }
    #[test]
    fn try_is_not_absolute_but_relative() {
        let path = Path::new("directory/test.txt");
        let res = is_absolute(&path);
        assert!(res.is_err());
    }
    #[test]
    fn try_is_not_absolute_but_filename() {
        let path = Path::new("test.txt");
        let res = is_absolute(&path);
        assert!(res.is_err());
    }
}