Add serde derive macros where applicable

Author: daviessm

Cargo.toml

@@ -20,6 +20,7 @@ exclude = [
 
 [dependencies]
 arrayvec = "0.7.2"
+serde = { version = "1.0", optional = true, features = ["derive"] }
 
 [dev-dependencies]
 assert_matches = "1.5.0"

src/internet/ip.rs

@@ -3,6 +3,7 @@ use super::super::*;
 ///Internet protocol headers version 4 & 6
 #[derive(Clone, Debug, Eq, PartialEq)]
 #[allow(clippy::large_enum_variant)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub enum IpHeader {
     Version4(Ipv4Header, Ipv4Extensions),
     Version6(Ipv6Header, Ipv6Extensions)

src/internet/ip_authentication.rs

@@ -12,6 +12,7 @@ pub type IPv6AuthenticationHeader = IpAuthenticationHeader;
 
 /// IP Authentication Header (rfc4302)
 #[derive(Clone)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub struct IpAuthenticationHeader {
     /// IP protocol number specifying the next header or transport layer protocol.
     ///
@@ -27,6 +28,7 @@ pub struct IpAuthenticationHeader {
     raw_icv_len: u8,
     /// Buffer containing the "Encoded Integrity Check Value-ICV" (variable).
     /// The length of the used data can be set via the `variable` (must be a multiple of 4 bytes).
+    #[cfg_attr(feature = "serde", serde(skip), serde(default = "default_raw_icv_buffer"))]
     raw_icv_buffer: [u8;0xfe*4],
 }
 
@@ -326,3 +328,9 @@ impl<'a> IpAuthenticationHeaderSlice<'a> {
         ).unwrap()
     }
 }
+
+#[feature("serde")]
+/// Used to create an empty buffer when deserializing using `serde`
+fn default_raw_icv_buffer() -> [u8;0xfe*4] {
+    [0;0xfe*4]
+}

src/internet/ipv4.rs

@@ -6,6 +6,7 @@ use std::slice::from_raw_parts;
 
 /// IPv4 header without options.
 #[derive(Clone)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub struct Ipv4Header {
     pub differentiated_services_code_point: u8,
     pub explicit_congestion_notification: u8,
@@ -28,6 +29,7 @@ pub struct Ipv4Header {
     pub destination: [u8;4],
     /// Length of the options in the options_buffer in bytes.
     options_len: u8,
+    #[cfg_attr(feature = "serde", serde(skip), serde(default = "default_options_buffer"))]
     options_buffer: [u8;40]
 }
 
@@ -729,3 +731,9 @@ impl<'a> Ipv4HeaderSlice<'a> {
         }
     }
 }
+
+#[feature("serde")]
+/// Used to create an empty buffer when deserializing using `serde`
+fn default_options_buffer() -> [u8;40] {
+    [0;40]
+}

src/internet/ipv4_extensions.rs

@@ -8,6 +8,7 @@ use super::super::*;
 /// Currently not supported:
 /// - Encapsulating Security Payload Header (ESP)
 #[derive(Clone, Debug, Eq, PartialEq, Default)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub struct Ipv4Extensions {
     pub auth: Option<IpAuthenticationHeader>,
 }

src/internet/ipv6.rs

@@ -5,6 +5,7 @@ use std::slice::from_raw_parts;
 
 ///IPv6 header according to rfc8200.
 #[derive(Clone, Debug, Eq, PartialEq, Default)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub struct Ipv6Header {
     pub traffic_class: u8,
     ///If non 0 serves as a hint to router and switches with multiple outbound paths that these packets should stay on the same path, so that they will not be reordered.

src/internet/ipv6_extensions.rs

@@ -19,6 +19,7 @@ use std::slice::from_raw_parts;
 /// * IP Mobility
 /// * Site Multihoming by IPv6 Intermediation (SHIM6)
 #[derive(Clone, Debug, Eq, PartialEq, Default)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub struct Ipv6Extensions {
     pub hop_by_hop_options: Option<Ipv6RawExtensionHeader>,
     pub destination_options: Option<Ipv6RawExtensionHeader>,
@@ -656,6 +657,7 @@ impl Ipv6Extensions {
 /// In case a route header is present it is also possible
 /// to attach a "final destination" header.
 #[derive(Clone, Debug, Eq, PartialEq)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub struct Ipv6RoutingExtensions {
     pub routing: Ipv6RawExtensionHeader,
     pub final_destination_options: Option<Ipv6RawExtensionHeader>

src/internet/ipv6_fragment.rs

@@ -4,6 +4,7 @@ use std::slice::from_raw_parts;
 
 /// IPv6 fragment header.
 #[derive(Clone, Debug, Eq, PartialEq)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub struct Ipv6FragmentHeader {
     /// IP protocol number specifying the next header or transport layer protocol.
     ///

src/internet/ipv6_raw_extension.rs

@@ -21,6 +21,7 @@ pub const IPV6_MAX_NUM_HEADER_EXTENSIONS: usize = 12;
 /// * Host Identity Protocol
 /// * Shim6 Protocol
 #[derive(Clone)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub struct Ipv6RawExtensionHeader {
     /// IP protocol number specifying the next header or transport layer protocol.
     ///
@@ -29,6 +30,7 @@ pub struct Ipv6RawExtensionHeader {
     /// Length of the extension header in 8 octets (minus the first 8 octets).
     header_length: u8,
     //// The data contained in the extension header (excluding next_header & hdr length).
+    #[cfg_attr(feature = "serde", serde(skip), serde(default = "default_payload_buffer"))]
     payload_buffer: [u8;0xff * 8 + 6],
 }
 
@@ -288,3 +290,9 @@ impl<'a> Ipv6RawExtensionHeaderSlice<'a> {
         ).unwrap()
     }
 }
+
+#[feature("serde")]
+/// Used to create an empty buffer when deserializing using `serde`
+fn default_payload_buffer() -> [u8;0xff * 8 + 6] {
+    [0;0xff * 8 + 6]
+}

src/link/ethernet.rs

@@ -58,6 +58,7 @@ pub mod ether_type {
 
 ///Ethernet II header.
 #[derive(Clone, Debug, Eq, PartialEq, Default)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub struct Ethernet2Header {
     pub source: [u8;6],
     pub destination: [u8;6],