soft-canonicalize 0.5.5

Path canonicalization that works with non-existing paths.
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

use std::borrow::Cow;
use std::path::{Path, PathBuf};
use std::{fmt, io};

/// Error payload used by this crate to attach the offending path to I/O errors.
#[derive(Debug, Clone)]
pub struct SoftCanonicalizeError {
    path: PathBuf,
    detail: Cow<'static, str>,
}

impl SoftCanonicalizeError {
    pub fn new(path: PathBuf, detail: impl Into<Cow<'static, str>>) -> Self {
        Self {
            path,
            detail: detail.into(),
        }
    }
    /// Offending path that caused the error
    pub fn path(&self) -> &Path {
        &self.path
    }
    /// Human-readable error detail (without the path suffix)
    pub fn detail(&self) -> &str {
        &self.detail
    }
}

impl fmt::Display for SoftCanonicalizeError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{} (path: '{}')", self.detail, self.path.display())
    }
}

impl std::error::Error for SoftCanonicalizeError {}

/// Convenience to create an io::Error with our path-aware payload.
#[inline]
pub(crate) fn error_with_path(
    kind: io::ErrorKind,
    path: &Path,
    detail: impl Into<Cow<'static, str>>,
) -> io::Error {
    io::Error::new(kind, SoftCanonicalizeError::new(path.to_path_buf(), detail))
}

/// Extension to extract our path-aware payload from io::Error.
pub trait IoErrorPathExt {
    fn offending_path(&self) -> Option<&Path>;
    fn soft_canon_detail(&self) -> Option<&str>;
}

impl IoErrorPathExt for io::Error {
    fn offending_path(&self) -> Option<&Path> {
        self.get_ref()
            .and_then(|e| e.downcast_ref::<SoftCanonicalizeError>())
            .map(|p| p.path())
    }

    fn soft_canon_detail(&self) -> Option<&str> {
        self.get_ref()
            .and_then(|e| e.downcast_ref::<SoftCanonicalizeError>())
            .map(|p| p.detail())
    }
}