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
use std::{error, fmt, io, path::PathBuf};

use file_type_enum::FileType;

/// An alias for `Result<T, fs_tree::Error>`.
pub type Result<T> = std::result::Result<T, Error>;

/// An enum for all errors generated in the `fs-tree` crate.
#[derive(Debug)]
pub enum Error {
    /// Expected directory, but file type differs.
    NotADirectoryError(PathBuf),
    /// Expected symlink, but file type differs.
    NotASymlinkError(PathBuf),
    /// Unsupported file type found.
    UnexpectedFileTypeError(FileType, PathBuf),
    /// An error with reading or writing.
    // TODO: Consider changing this to IoError(io::Error, PathBuf)
    IoError(io::Error),
}

use Error::*;

impl Error {
    /// The path related to this error, if any.
    pub fn path(&self) -> Option<&PathBuf> {
        match self {
            NotADirectoryError(path)
            | NotASymlinkError(path)
            | UnexpectedFileTypeError(_, path) => Some(path),
            IoError(..) => None,
        }
    }
}

impl error::Error for Error {
    fn source(&self) -> Option<&(dyn error::Error + 'static)> {
        match self {
            IoError(source) => Some(source),
            _ => None,
        }
    }
}

impl fmt::Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "FsError: ")?;

        match self {
            NotADirectoryError(..) => write!(f, "not a directory"),
            NotASymlinkError(..) => write!(f, "not a symlink"),
            UnexpectedFileTypeError(..) => write!(f, "unexpected file type"),
            IoError(inner) => inner.fmt(f),
        }
    }
}

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