(feat): Add serde feature flag

Author: neeldug

Cargo.toml

@@ -9,3 +9,6 @@ repository = "https://github.com/kevinmehall/rust-vcd"
 categories = ["parser-implementations", "encoding"]
 readme = "README.md"
 edition = "2018"
+
+[dependencies]
+serde = { version = "^1.0", optional = true, features = ["derive"] }

src/idcode.rs

@@ -27,6 +27,7 @@ impl Error for InvalidIdCode { }
 
 /// An ID used within the file to refer to a particular variable.
 #[derive(Debug, Copy, Clone, Eq, PartialEq, PartialOrd, Ord, Hash)]
+#[cfg_attr(feature="serde", derive(serde::Serialize, serde::Deserialize))]
 pub struct IdCode(u64);
 
 const ID_CHAR_MIN: u8 = b'!';

src/lib.rs

@@ -146,6 +146,7 @@ pub(crate) use unit_error_struct;
 
 /// An element in a VCD file.
 #[derive(Debug, PartialEq, Clone)]
+#[cfg_attr(feature="serde", derive(serde::Serialize, serde::Deserialize))]
 #[non_exhaustive]
 pub enum Command {
     /// A `$comment` command
@@ -198,6 +199,7 @@ pub enum Command {
 
 /// A simulation command type, used in `Command::Begin` and `Command::End`.
 #[derive(Debug, Copy, Clone, Eq, PartialEq)]
+#[cfg_attr(feature="serde", derive(serde::Serialize, serde::Deserialize))]
 #[non_exhaustive]
 #[allow(missing_docs)]
 pub enum SimulationCommand {
@@ -228,6 +230,7 @@ impl Display for SimulationCommand {
 /// A `Header` can be parsed from VCD with [`Parser::parse_header`], or create an
 /// empty `Header` with [`Header::default`].
 #[derive(Debug, Default)]
+#[cfg_attr(feature="serde", derive(serde::Serialize, serde::Deserialize))]
 #[non_exhaustive]
 pub struct Header {
     /// `$date` text

src/scope.rs

@@ -5,6 +5,7 @@ use crate::IdCode;
 
 /// A type of scope, as used in the `$scope` command.
 #[derive(Debug, Copy, Clone, Eq, PartialEq)]
+#[cfg_attr(feature="serde", derive(serde::Serialize, serde::Deserialize))]
 #[non_exhaustive]
 #[allow(missing_docs)]
 pub enum ScopeType {
@@ -51,6 +52,7 @@ impl Display for ScopeType {
 
 /// A type of variable, as used in the `$var` command.
 #[derive(Debug, Copy, Clone, Eq, PartialEq)]
+#[cfg_attr(feature="serde", derive(serde::Serialize, serde::Deserialize))]
 #[non_exhaustive]
 #[allow(missing_docs)]
 pub enum VarType {
@@ -136,6 +138,7 @@ impl Display for VarType {
 
 /// Information on a VCD scope as represented by a `$scope` command and its children.
 #[derive(Debug, Clone, PartialEq)]
+#[cfg_attr(feature="serde", derive(serde::Serialize, serde::Deserialize))]
 #[non_exhaustive]
 pub struct Scope {
     /// Type of scope.
@@ -186,6 +189,7 @@ impl Default for Scope {
 /// assert_eq!("[7:0]".parse(), Ok(ReferenceIndex::Range(7, 0)));
 /// ```
 #[derive(Debug, Copy, Clone, PartialEq)]
+#[cfg_attr(feature="serde", derive(serde::Serialize, serde::Deserialize))]
 pub enum ReferenceIndex {
     /// Single bit (e.g `[0]`)
     BitSelect(i32),
@@ -245,6 +249,7 @@ fn test_parse_reference_index() {
 
 /// Information on a VCD variable as represented by a `$var` command.
 #[derive(Debug, Clone, PartialEq)]
+#[cfg_attr(feature="serde", derive(serde::Serialize, serde::Deserialize))]
 #[non_exhaustive]
 pub struct Var {
     /// Type of variable.
@@ -281,6 +286,7 @@ impl Var {
 
 /// An item in a scope
 #[derive(Debug, Clone, PartialEq)]
+#[cfg_attr(feature="serde", derive(serde::Serialize, serde::Deserialize))]
 #[non_exhaustive]
 pub enum ScopeItem {
     /// `$scope` - Child scope

src/timescale.rs

@@ -3,6 +3,7 @@ use std::str::FromStr;
 
 /// A unit of time for the `$timescale` command.
 #[derive(Debug, Copy, Clone, Eq, PartialEq)]
+#[cfg_attr(feature="serde", derive(serde::Serialize, serde::Deserialize))]
 pub enum TimescaleUnit {
     /// Second
     S,

src/value.rs

@@ -4,6 +4,7 @@ use std::str::FromStr;
 
 /// A four-valued logic scalar value.
 #[derive(Debug, Copy, Clone, Eq, PartialEq)]
+#[cfg_attr(feature="serde", derive(serde::Serialize, serde::Deserialize), serde(tag = "type"))]
 pub enum Value {
     /// Logic low
     ///
@@ -79,6 +80,7 @@ impl Display for Value {
 /// This currently wraps a `Vec<Value>` but could be implemented with
 /// a bitmap in the future.
 #[derive(Clone, PartialEq, Eq)]
+#[cfg_attr(feature="serde", derive(serde::Serialize, serde::Deserialize))]
 pub struct Vector(Vec<Value>);
 
 impl Vector {