first gentle test of adding serde support selectively.

Will miniserde work as well?

Author: Byron

Cargo.lock

@@ -175,7 +175,8 @@ The top-level command-line interface.
 
 ### git-features
 
-A crate to help controlling which capabilities are available from the top-level crate that uses `gitoxide`.
+A crate to help controlling which capabilities are available from the top-level crate that uses `gitoxide-core` or any other
+`gitoxide` crate that uses `git-features`.
 All feature toggles are additive.
 
 * **parallel** _(optional)_
@@ -193,6 +194,18 @@ All feature toggles are additive.
     interface for progress.
   * This is by far the most expensive progress option, as it pulls in an `async` TUI along with supporting infrastructure,
     which is kept minimal but has quite a footprint nonetheless.
+    
+ ### Serialization Support
+ 
+ What follows is feature toggles to control serialization of all public facing simple data types.
+ 
+ * **with-serde**
+   * Data structures implement `serde::Serialize` and `serde::Deserialize`
+ 
+ The features above are provided by the crates
+ 
+ * **git-object**
+
 
 ## Development Practices
 

README.md

@@ -8,13 +8,17 @@ edition = "2018"
 [lib]
 doctest = false
 
+[features]
+with-serde = ["serde"]
+
 [dependencies]
 quick-error = "1.2.3"
 hex = "0.4.2"
 btoi = "0.4.2"
 bstr = { version = "0.2.13", default-features = false, features = ["std"] }
 nom = { version = "6.0.0-alpha1", default-features = false, features = ["alloc"]}
 smallvec = "1.4.0"
+serde = { version = "1.0.114", optional = true, default-features = false, features = ["derive"]}
 
 [dev-dependencies]
 pretty_assertions = "0.6.1"

git-object/Cargo.toml

@@ -3,13 +3,18 @@ use nom::lib::std::fmt::Formatter;
 use nom::lib::std::ops::Deref;
 use quick_error::quick_error;
 
+#[cfg(feature = "with-serde")]
+use serde::{Deserialize, Serialize};
+
 #[derive(PartialEq, Eq, Debug, Hash, Ord, PartialOrd, Clone, Copy)]
+#[cfg_attr(feature = "with-serde", derive(Serialize, Deserialize))]
 pub enum Sign {
     Plus,
     Minus,
 }
 
 #[derive(PartialEq, Eq, Debug, Hash, Ord, PartialOrd, Clone, Copy)]
+#[cfg_attr(feature = "with-serde", derive(Serialize, Deserialize))]
 pub struct Time {
     /// time in seconds from epoch
     pub time: u32,
@@ -23,6 +28,7 @@ pub const SHA1_SIZE: usize = 20;
 
 /// A SHA1 identifying objects
 #[derive(PartialEq, Eq, Debug, Hash, Ord, PartialOrd, Clone, Copy)]
+#[cfg_attr(feature = "with-serde", derive(Serialize, Deserialize))]
 pub struct Id(pub [u8; SHA1_SIZE]);
 
 impl Id {
@@ -67,6 +73,7 @@ impl std::fmt::Display for Id {
 }
 
 #[derive(PartialEq, Eq, Debug, Hash, Ord, PartialOrd, Clone, Copy)]
+#[cfg_attr(feature = "with-serde", derive(Serialize, Deserialize))]
 pub enum Kind {
     Tree,
     Blob,