summaryrefslogtreecommitdiff
path: root/graph/src/error.rs
diff options
context:
space:
mode:
Diffstat (limited to 'graph/src/error.rs')
-rw-r--r--graph/src/error.rs26
1 files changed, 26 insertions, 0 deletions
diff --git a/graph/src/error.rs b/graph/src/error.rs
new file mode 100644
index 0000000..2162685
--- /dev/null
+++ b/graph/src/error.rs
@@ -0,0 +1,26 @@
+#![warn(missing_docs)]
+//! This file implements the error data type of the graph library.
+
+use std::fmt::{self, Display};
+
+/// The error type for methods of the trait [`Graph`][`super::Graph`].
+#[derive(Debug, Clone, PartialEq, Eq, Ord, PartialOrd)]
+pub enum Error {
+ /// The index is out of bounds.
+ ///
+ /// The first component is the index that is out of bounds, and
+ /// the second component is the current length of nodes.
+ IndexOutOfBounds(usize, usize),
+}
+
+impl Display for Error {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ match self {
+ Error::IndexOutOfBounds(index, len) => {
+ write!(f, "index {index} out of bounds {len} ")
+ }
+ }
+ }
+}
+
+impl std::error::Error for Error {}