stree 0.1.0

A directory hierarchy mapping format, similar to mtree
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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139

//! Error definition for the crate

use std::fmt::{self, Debug, Display};
use std::io;

pub(crate) type Result<T, E = Error> = std::result::Result<T, E>;

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

unsafe impl Send for Error {}
unsafe impl Sync for Error {}

/// Represents an error from the stree crate
pub enum Error
{
    /// Mainly for errors generated by this crate
    General(String),
    /// I/O errors
    Io(io::Error),
    /// Generic well-implemented errors
    External(Box<dyn std::error::Error + Send + Sync>)
}

impl Display for Error
{
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result
    {
        match self
        {
            Self::General(msg) => write!(f, "{msg}"),
            Self::Io(e) => write!(f, "{e}"),
            Self::External(e) => write!(f, "{e}")
        }
    }
}

impl Debug for Error
{
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result
    {
        write!(f, "{self}")
    }
}

impl From<io::Error> for Error
{
    fn from(e: io::Error) -> Self
    {
        Self::io(e)
    }
}

impl From<pathstr::Error> for Error
{
    fn from(e: pathstr::Error) -> Self
    {
        Self::external(Box::new(e))
    }
}

impl From<rhash_rs::Error> for Error
{
    fn from(e: rhash_rs::Error) -> Self
    {
        Self::external(Box::new(e))
    }
}

impl From<std::num::ParseIntError> for Error
{
    fn from(e: std::num::ParseIntError) -> Self
    {
        Self::external(Box::new(e))
    }
}

impl From<Box<dyn std::error::Error + Send + Sync>> for Error
{
    fn from(e: Box<dyn std::error::Error + Send + Sync>) -> Self
    {
        Self::external(e)
    }
}

impl Error
{
    /// Construct a general error from a string
    pub fn new<S>(msg: S) -> Self
    where S: Into<String>
    {
        Self::General(msg.into())
    }

    /// Construct an error from an io error
    pub fn io(e: io::Error) -> Self
    {
        Self::Io(e)
    }
    
    /// Construct an error from a well-implemented generic error
    pub fn external(e: Box<dyn std::error::Error + Send + Sync>) -> Self
    {
        Self::External(e)
    }
}

impl From<walkdir::Error> for Error
{
    fn from(e: walkdir::Error) -> Self
    {
        Self::external(Box::new(e))
    }
}

macro_rules! error
{
    ($msg:literal $(, $($arg:tt)*)?) =>
    {
        return Err($crate::error::Error::new(::std::format!($msg $(, $($arg)*)?)))
    };
    ($msg:expr) =>
    {
        return Err($crate::error::Error::new(::std::format!("{}", $msg)))
    };
}

macro_rules! err
{
    ($msg:literal $(, $($arg:tt)*)?) =>
    {
        $crate::error::Error::new(::std::format!($msg $(, $($arg)*)?))
    };
    ($msg:expr) =>
    {
        $crate::error::Error::new(::std::format!("{}", $msg))
    };
}

pub(crate) use {err, error};