prepona 0.1.0

A graph crate with simplicity in mind
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

/// Types of errors that may happen when using one of the algorithms.
pub enum ErrorKind {
    EulerianTrailNotFound,
    EulerianCircuitNotFound,
    NegativeCycleDetected,
}

/// Error type returns in [`algo`](crate::algo) module.
pub struct Error {
    kind: ErrorKind,
    msg: String,
}

impl Error {
    /// # Arguments
    /// * `kind`: Specifies what kind of error is being created.
    /// * `msg`: Cause of the error.
    ///
    /// # Returns
    /// Constructed `Error`.
    pub fn new(kind: ErrorKind, msg: String) -> Self {
        Error { kind, msg }
    }

    /// Creates a new [`EulerianTrailNotFound`](crate::algo::ErrorKind::EulerianTrailNotFound) kind of error.
    ///
    /// # Returns
    /// `Error` with `EulerianTrailNotFound` kind and predefined message.
    pub fn new_etnf() -> Self {
        Error {
            kind: ErrorKind::EulerianTrailNotFound,
            msg: format!("Eulerian trail not found"),
        }
    }

    /// Creates a new [`EulerianCircuitNotFound`](crate::algo::ErrorKind::EulerianCircuitNotFound) kind of error.
    ///
    /// # Returns
    /// `Error` with `EulerianCircuitNotFound` kind and predefined message.
    pub fn new_ecnf() -> Self {
        Error {
            kind: ErrorKind::EulerianCircuitNotFound,
            msg: format!("Eulerian circuit not found"),
        }
    }

    pub fn new_ncd() -> Self {
        Error {
            kind: ErrorKind::NegativeCycleDetected,
            msg: format!("Graph contains cycle"),
        }
    }

    /// # Returns
    /// Message inside of the error.
    pub fn msg(&self) -> &str {
        &self.msg
    }

    /// # Returns
    /// What kind the error is.
    pub fn kind(&self) -> &ErrorKind {
        &self.kind
    }
}

impl std::fmt::Debug for Error {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.write_str(self.msg())
    }
}

impl std::fmt::Display for Error {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.write_str(self.msg())
    }
}

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