tree-ds 0.2.0

A library to manipulate tree data structures.
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

#[cfg(not(feature = "no_std"))]
use thiserror::Error;

use crate::lib::*;

/// The error type for this crate.
#[cfg_attr(not(feature = "no_std"), derive(Error))]
#[derive(Clone, PartialEq)]
pub enum Error {
    /// The root node is already present in the tree.
    #[cfg_attr(
        not(feature = "no_std"),
        error("Error: Root node already present in the tree. You cannot add another root node.")
    )]
    RootNodeAlreadyPresent,
    /// An invalid operation was performed on the tree.
    #[cfg_attr(not(feature = "no_std"), error("Error: {0}"))]
    InvalidOperation(String),
    /// The node was not found in the tree.
    #[cfg_attr(
        not(feature = "no_std"),
        error("Error: Node {0} not found in the tree.")
    )]
    NodeNotFound(String),
    /// An error occurred while formatting the output.
    #[allow(clippy::enum_variant_names)]
    #[cfg_attr(not(feature = "no_std"), error(transparent))]
    FmtError(FmtError),
}

#[cfg(feature = "no_std")]
impl Display for Error {
    /// Formats the error message.
    fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult {
        match self {
            Error::RootNodeAlreadyPresent => write!(
                f,
                "Error: Root node already present in the tree. You cannot add another root node."
            ),
            Error::InvalidOperation(s) => write!(f, "Error: {s}"),
            Error::NodeNotFound(s) => write!(f, "Error: Node {s} not found in the tree."),
            Error::FmtError(_) => {
                write!(f, "Error: An error occurred while formatting the output.")
            }
        }
    }
}

impl Debug for Error {
    /// Formats the error message.
    fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult {
        write!(f, "{self}")
    }
}

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

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_error_fmt() {
        let err = Error::InvalidOperation("Invalid operation".to_string());
        assert_eq!(format!("{err:?}"), "Error: Invalid operation");
    }

    #[test]
    fn test_error_fmt_root_node_already_present() {
        let err = Error::RootNodeAlreadyPresent;
        assert_eq!(
            format!("{err:?}"),
            "Error: Root node already present in the tree. You cannot add another root node."
        );
    }

    #[test]
    fn test_error_from_fmt_error() {
        let err = Error::FmtError(FmtError);
        assert_eq!(Error::from(FmtError), err);
    }
}