x-path 0.1.0-alpha.0

x-path is a if-it-compiles-it-works solution for safe Rust paths with abs/rel and file/dir variants for API safety and cross platform support
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

use super::CharExt;

use anyhow::{bail, ensure, Result};

pub(crate) trait StrExt {
    fn is_slash(&self) -> bool;
    fn is_current_dir(&self) -> bool;
    fn is_user_dir(&self) -> bool;
    fn assert_allowed_path_component(&self) -> Result<()>;
}

impl StrExt for str {
    fn is_slash(&self) -> bool {
        self == "/" || self == "\\"
    }

    fn is_current_dir(&self) -> bool {
        self == "./" || self == ".\\" || self == "."
    }

    fn is_user_dir(&self) -> bool {
        self == "~/" || self == "~\\" || self == "~"
    }

    fn assert_allowed_path_component(&self) -> Result<()> {
        ensure!(
            self.len() <= 255,
            "path components can have a maximum length of 255 characters but this was {}: {self}",
            self.len(),
        );
        for c in self.chars() {
            if c.is_forbidden_in_path() {
                if c.is_ascii_control() {
                    bail!(
                        "forbidden ascii control character {:#x} in path segment: {self}",
                        c as i32
                    );
                } else {
                    bail!("forbidden ascii character {c} in path segment: {self}")
                }
            }
        }
        Ok(())
    }
}