Updated code to be in line with C-SERDE Rust API Guideline

Author: LMH01

Cargo.lock

@@ -7,12 +7,14 @@ edition = "2021"
 
 [features]
 from_instruction = []
+serde = ["dep:serde"]
 
 [dependencies]
+serde = { version = "1.0", optional = true, features = ["derive"] }
 
 [dev-dependencies]
 criterion = { version = "0.4", features = ["html_reports"] }
 
 [[bench]]
 name = "algorithm_benchmark"
-harness = false
+harness = false

Cargo.toml

@@ -17,6 +17,9 @@
 //! | Dijkstra | 52.3155 ms |
 use std::{fmt::Display, hash::Hash, collections::{BinaryHeap, HashSet}, rc::Rc, cell::RefCell};
 
+#[cfg(feature = "serde")]
+use serde::{Serialize, Deserialize};
+
 use crate::{Graph, Node, ShortestPathTree};
 
 /// Calculates the shortest distance between one source node and all other nodes on the graph using 
@@ -239,6 +242,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, PartialOrd, Ord, Eq, Clone, Copy, Hash)]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 pub enum RunAlgorithmError {
     /// Indicates that the source node is not contained within the graph.
     SourceNodeMissing,

src/algorithms.rs

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

src/instruction.rs

@@ -46,8 +46,13 @@
 //! | Feature | Description |
 //! | - | - |
 //! | from_instruction | Enables functionality that allows graphs to be parsed from a list of instructions. |
+//! | serde | Serde serialization and deserialization support for some objects. |
 
 use std::{fmt::{Display, Debug}, rc::Rc, cell::RefCell, collections::HashMap, hash::Hash};
+
+#[cfg(feature = "serde")]
+use serde::{Serialize, Deserialize};
+
 /// Contains implementations for the graph to work.
 mod graph;
 /// Contains all algorithms that are implemented in this crate.
@@ -120,6 +125,7 @@ impl<T: Display + Eq + Hash> Graph<T> {
 /// Structure to store the shortest path and distance from one node 
 /// to other nodes after a pathfinding algorithm has been run on a graph.
 #[derive(Eq, PartialEq, Debug)]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 pub struct ShortestPathTree<T: Display + Clone + Hash + Eq> {
     source: T,
     results: HashMap<T, Option<(i32, ShortestPath<T>)>>,
@@ -213,6 +219,7 @@ impl<T: Display + Clone + Eq + Hash> ShortestPathTree<T> {
 
 /// The shortest path from one node to another.
 #[derive(Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug)]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 pub struct ShortestPath<T: Display + Clone> {// Add documentation
     /// Contains a list of node ids, first entry is the start node, last entry is the target node.
     path: Vec<T>, //TODO maybe add later that the distance between each node is stored as well
@@ -374,10 +381,11 @@ impl<T: Display + Clone + Eq> TryFrom<&Rc<RefCell<Node<T>>>> for ShortestPath<T>
     }
 }
 
-#[derive(Clone, Eq, PartialEq, PartialOrd, Ord, Hash, Debug)]
 /// Errors that can occur when edges are added to the graph.
 /// 
 /// Variants specify what exact node is missing.
+#[derive(Clone, Eq, PartialEq, PartialOrd, Ord, Hash, Debug)]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 pub enum AddEdgeError {
     /// Indicates that the source node is missing from the graph,
     SourceMissing,