Began to improve code to be in line with Rust API Guidelines C-COMMON-TRAITS

Author: LMH01

src/algorithms.rs

@@ -238,7 +238,7 @@ pub fn bellman_ford<T: Display + Eq + Clone + Hash>(graph: &mut Graph<T>, source
 }
 
 /// Errors that can occur when algorithms are run.
-#[derive(Debug, PartialEq)]
+#[derive(Debug, PartialEq, PartialOrd, Ord, Eq, Clone, Copy, Hash)]
 pub enum RunAlgorithmError {
     /// Indicates that the source node is not contained within the graph.
     SourceNodeMissing,

src/graph.rs

@@ -380,7 +380,7 @@ impl<T: Display + Clone + Eq + Hash> Default for Graph<T> {
     }
 }
 
-impl<T: Display> Display for Graph<T> {
+impl<T: Display + Eq + Hash> Display for Graph<T> {
     /// Formats the graph to show all edges between nodes
     fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
         let mut graph = String::new();

src/instruction.rs

@@ -40,7 +40,7 @@ use std::{fmt::Display, hash::Hash};
 use crate::Graph;
 
 #[cfg(feature = "from_instruction")]
-#[derive(Debug, PartialEq)]
+#[derive(Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug)]
 enum Instruction<T: Display + Clone> {
     AddNode(T),
     AddEdge(i32, T, T),
@@ -49,7 +49,7 @@ enum Instruction<T: Display + Clone> {
 
 /// A list of instructions used to construct a graph.
 #[cfg(feature = "from_instruction")]
-#[derive(Debug, PartialEq)]
+#[derive(Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug)]
 pub struct Instructions<T: Display + Clone> {
     instructions: Vec<Instruction<T>>,
 }

src/lib.rs

@@ -57,8 +57,8 @@ pub mod algorithms;
 pub mod instruction;
 
 /// A node inside the graph
-#[derive(Debug, Clone, Eq)]
-struct Node<T: Display> {
+#[derive(Clone, Eq, Debug)]
+struct Node<T: Display + Eq> {
     /// Identifier of this node
     id: T,
     /// Edges of this node
@@ -70,8 +70,8 @@ struct Node<T: Display> {
 }
 
 // An edge between two nodes inside a graph
-#[derive(Debug, Clone, Eq)]
-struct Edge<T: Display> {
+#[derive(Clone, Eq, Ord, PartialOrd, Debug)]
+struct Edge<T: Display + Eq> {
     /// The "cost" of moving along this edge
     weight: i32,
     /// The parent of this edge
@@ -81,16 +81,30 @@ struct Edge<T: Display> {
 }
 
 /// Graph data structure to organize nodes that are connected to each other with edges.
-#[derive(Debug)]
-pub struct Graph<T: Display> {
+#[derive(Clone, Debug, PartialEq, Eq)]
+pub struct Graph<T: Display + Eq + Hash> {
     /// All nodes contained in this graph
     //nodes: Vec<Rc<RefCell<Node<T>>>>,
 
     /// Stores all nodes contained in this graph mapped to the node's id.
     nodes: HashMap<T, Rc<RefCell<Node<T>>>>,
 }
 
-impl<T: Display> Graph<T> {
+impl<T: Display + Eq + Hash + Clone> PartialOrd for Graph<T> {
+    /// Compares the size of this graph with the size of another graph.
+    fn partial_cmp(&self, other: &Self) -> Option<std::cmp::Ordering> {
+        self.size().partial_cmp(&other.size())
+    }
+}
+
+impl<T: Display + Eq + Hash + Clone> Ord for Graph<T> {
+    /// Compares the size of this graph with the size of another graph.
+    fn cmp(&self, other: &Self) -> std::cmp::Ordering {
+        self.size().cmp(&other.size())
+    }
+}
+
+impl<T: Display + Eq + Hash> Graph<T> {
 
     /// Resets the distance of each node in the graph back to `i32::MAX` and resets the shortest path string.
     /// 
@@ -335,7 +349,7 @@ impl<T: Display + Clone + Debug> Display for ShortestPath<T> {
 }
 
 #[doc(hidden)]
-impl<T: Display + Clone> TryFrom<&Rc<RefCell<Node<T>>>> for ShortestPath<T> {
+impl<T: Display + Clone + Eq> TryFrom<&Rc<RefCell<Node<T>>>> for ShortestPath<T> {
     type Error = &'static str;
 
     /// Tries to read the shortest path from the node.