Merge pull request #57 from hashmismatch/serde_feature

Serde as an optional feature

Author: rudib

packed_struct/Cargo.toml

@@ -12,19 +12,16 @@ categories = ["encoding"]
 readme = "../README.md"
 
 [dependencies]
-serde_derive = "1.0"
-
-[dependencies.serde]
-version = "1.0"
-default-features = false
-
+serde = { version = "1.0", optional = true, default-features = false }
+serde_derive = { version = "1.0", optional = true }
 
 [features]
 default = ["std"]
 std = ["serde/std"]
 alloc = []
 byte_types_64 = []
 byte_types_256 = []
+use_serde = ["serde", "serde_derive"]
 
 # comment this section when publishing new releases to crates.io!
 [dev-dependencies]

packed_struct/src/lib.rs

@@ -287,7 +287,9 @@
 extern crate alloc;
 
 
+#[cfg(feature = "use_serde")]
 extern crate serde;
+#[cfg(feature = "use_serde")]
 #[macro_use] extern crate serde_derive;
 
 mod internal_prelude;

packed_struct/src/packing.rs

@@ -41,7 +41,8 @@ pub trait PackedStructSlice where Self: Sized {
     }
 }
 
-#[derive(Debug, Copy, Clone, PartialEq, Serialize)]
+#[cfg_attr(feature = "use_serde", derive(Serialize, Deserialize))]
+#[derive(Debug, Copy, Clone, PartialEq)]
 /// Packing errors that might occur during packing or unpacking
 pub enum PackingError {
     InvalidValue,

packed_struct/src/types_num.rs

@@ -28,21 +28,25 @@ impl<T, B> Display for Integer<T, B> where T: Display {
     }
 }
 
-use serde::ser::{Serialize, Serializer};
-impl<T, B> Serialize for Integer<T, B> where T: Serialize {
-    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
-        where S: Serializer
-    {
-        self.num.serialize(serializer)
+#[cfg(feature = "use_serde")]
+mod serialize {
+    use serde::ser::{Serialize, Serializer};
+    use serde::de::{Deserialize, Deserializer};
+
+    impl<T, B> Serialize for super::Integer<T, B> where T: Serialize {
+        fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
+            where S: Serializer
+        {
+            self.num.serialize(serializer)
+        }
     }
-}
 
-use serde::de::{Deserialize, Deserializer};
-impl<'de, T, B> Deserialize<'de> for Integer<T, B> where T: Deserialize<'de>, T: Into<Integer<T, B>> {
-    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
-        where D: Deserializer<'de>
-    {
-        <T>::deserialize(deserializer).map(|n| n.into())
+    impl<'de, T, B> Deserialize<'de> for super::Integer<T, B> where T: Deserialize<'de>, T: Into<super::Integer<T, B>> {
+        fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
+            where D: Deserializer<'de>
+        {
+            <T>::deserialize(deserializer).map(|n| n.into())
+        }
     }
 }
 

packed_struct/src/types_reserved.rs

@@ -14,15 +14,17 @@ pub trait ReservedBitValue {
     fn get_reserved_bit_value_byte() -> u8;
 }
 
-#[derive(Default, Copy, Clone, Debug, PartialEq, Serialize, Deserialize)]
+#[cfg_attr(feature = "use_serde", derive(Serialize, Deserialize))]
+#[derive(Default, Copy, Clone, PartialEq)]
 pub struct BitOne;
 impl ReservedBitValue for BitOne {
     fn get_reserved_bit_value_byte() -> u8 {
         0xFF
     }
 }
 
-#[derive(Default, Copy, Clone, Debug, PartialEq, Serialize, Deserialize)]
+#[cfg_attr(feature = "use_serde", derive(Serialize, Deserialize))]
+#[derive(Default, Copy, Clone, PartialEq)]
 pub struct BitZero;
 impl ReservedBitValue for BitZero {
     fn get_reserved_bit_value_byte() -> u8 {
@@ -31,7 +33,8 @@ impl ReservedBitValue for BitZero {
 }
 
 /// Always packs into the associated bit value. Ignores the input when unpacking.
-#[derive(Default, Copy, Clone, PartialEq, Serialize, Deserialize)]
+#[cfg_attr(feature = "use_serde", derive(Serialize, Deserialize))]
+#[derive(Default, Copy, Clone, PartialEq)]
 pub struct ReservedBits<V, B> {
     value: V,
     bits: PhantomData<B>

packed_struct_tests/Cargo.toml

@@ -5,6 +5,7 @@ authors = ["Rudi Benkovic <[email protected]>"]
 publish = false
 
 [dependencies]
-packed_struct = { version = "0.4", features = ["byte_types_64"] }
+packed_struct = { version = "0.4", features = ["byte_types_64", "use_serde"] }
 packed_struct_codegen = "0.4"
-error-chain = "0.12.0"
+error-chain = "0.12.0"
+serde = "1.0"

packed_struct_tests/tests/test_serde.rs

@@ -0,0 +1,22 @@
+extern crate packed_struct;
+extern crate serde;
+
+
+use packed_struct::prelude::*;
+
+#[test]
+fn test_serialization_traits() {
+
+    check_serde_support::<Integer<u8, packed_bits::Bits8>>();
+    check_serde_support::<PackingError>();
+    check_serde_support::<BitOne>();
+    check_serde_support::<BitZero>();
+    check_serde_support::<ReservedBits<u8, packed_bits::Bits8>>();
+}
+
+fn check_serde_support<'a, T>() 
+    where 
+        T: serde::Serialize,
+        T: serde::Deserialize<'a>
+{
+}