Add optional serde derives on most public types (#39)

* add serde derives * fmt
I-CAN-hack · Mar 18, 2024 · 6d7fed3 · 6d7fed3
1 parent fb650f5
commit 6d7fed3
Show file tree

Hide file tree

Showing 9 changed files with 18 additions and 1 deletion.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -10,8 +10,10 @@ repository = "https://github.com/I-CAN-hack/automotive"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [features]
+all = []
 test_panda = []
 test_socketcan = []
+serde = ["dep:serde"]
 
 [dependencies]
 async-stream = "^0.3.5"
@@ -21,6 +23,7 @@ futures-core = "^0.3.30"
 futures-util = "^0.3.30"
 hex = "^0.4"
 rusb = "^0.9"
+serde = {version = "^1.0.197", features = ["derive"], optional = true}
 serial_test = "^3.0.0"
 strum = "^0.26"
 strum_macros = "^0.26"

diff --git a/src/can.rs b/src/can.rs
@@ -4,6 +4,7 @@ use std::fmt;
 
 /// Identifier for a CAN frame
 #[derive(Copy, Clone, PartialOrd, Eq, PartialEq, Hash)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub enum Identifier {
     Standard(u32),
     Extended(u32),
@@ -51,6 +52,7 @@ impl From<Identifier> for u32 {
 
 /// A CAN frame
 #[derive(Clone, PartialEq)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub struct Frame {
     /// The bus index for adapters supporting multiple CAN busses
     pub bus: u8,

diff --git a/src/isotp/constants.rs b/src/isotp/constants.rs
@@ -4,6 +4,7 @@ pub static FRAME_TYPE_MASK: u8 = 0xf0;
 pub static FLOW_SATUS_MASK: u8 = 0x0f;
 
 #[derive(Debug, PartialEq, Copy, Clone, FromRepr)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[repr(u8)]
 pub enum FrameType {
     Single = 0x00,
@@ -13,6 +14,7 @@ pub enum FrameType {
 }
 
 #[derive(Debug, PartialEq, Copy, Clone, FromRepr)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[repr(u8)]
 pub enum FlowStatus {
     ContinueToSend = 0x0,

diff --git a/src/isotp/mod.rs b/src/isotp/mod.rs
@@ -36,6 +36,7 @@ const DEFAULT_TIMEOUT_MS: u64 = 100;
 
 /// Configuring passed to the IsoTPAdapter.
 #[derive(Debug, Clone, Copy)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub struct IsoTPConfig {
     pub bus: u8,
     /// Transmit ID
@@ -243,7 +244,6 @@ impl<'a> IsoTPAdapter<'a> {
             unimplemented!("CAN FD escape sequence for first frame not supported");
         }
 
-
         buf.extend(&frame.data[2..]);
 
         // Send Flow Control

diff --git a/src/isotp/types.rs b/src/isotp/types.rs
@@ -1,6 +1,7 @@
 use crate::can::Frame;
 
 #[derive(Debug, Copy, Clone)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub struct FlowControlConfig {
     pub block_size: u8,
     pub separation_time_min: std::time::Duration,

diff --git a/src/uds/constants.rs b/src/uds/constants.rs
@@ -7,6 +7,7 @@ pub static ZERO_SUB_FUNCTION: u8 = 0x00;
 
 /// Service Identifiers (SIDs) as defined in ISO 14229
 #[derive(Debug, PartialEq, Copy, Clone, EnumIter)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[repr(u8)]
 pub enum ServiceIdentifier {
     // Diagnostic and Communication Management
@@ -50,6 +51,7 @@ pub enum ServiceIdentifier {
 
 /// Standard Data Identifiers (DIDs) as defined in ISO 14229
 #[derive(Debug, PartialEq, Copy, Clone, EnumIter)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[repr(u16)]
 pub enum DataIdentifier {
     BootSoftwareIdentification = 0xf180,
@@ -87,6 +89,7 @@ pub enum DataIdentifier {
 
 /// Diagnostic Session Type Sub-Function ID as defined in ISO 14229
 #[derive(Debug, PartialEq, Copy, Clone)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[repr(u8)]
 pub enum SessionType {
     Default = 0x01,
@@ -97,6 +100,7 @@ pub enum SessionType {
 
 /// ECU Reset Sub-Function ID as defined in ISO 14229
 #[derive(Debug, PartialEq, Copy, Clone)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[repr(u8)]
 pub enum ResetType {
     /// Simulates power-on/start-up sequence after a power loss
@@ -111,6 +115,7 @@ pub enum ResetType {
 
 /// Security Access Type Sub-Function ID as defined in ISO 14229
 #[derive(Debug, PartialEq, Copy, Clone)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[repr(u8)]
 pub enum SecurityAccessType {
     RequestSeed = 0x01,
@@ -119,6 +124,7 @@ pub enum SecurityAccessType {
 
 /// ROutine Control Sub-Function ID as defined in ISO 14229
 #[derive(Debug, PartialEq, Copy, Clone)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[repr(u8)]
 pub enum RoutineControlType {
     Start = 0x01,

diff --git a/src/uds/error.rs b/src/uds/error.rs
@@ -3,6 +3,7 @@ use thiserror::Error;
 
 /// Negative Response Codes returned by ECU as defined in ISO 14229
 #[derive(Debug, Copy, Clone, Eq, PartialEq)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[repr(u8)]
 pub enum NegativeResponseCode {
     GeneralReject = 0x10,

diff --git a/src/uds/types.rs b/src/uds/types.rs
@@ -4,6 +4,7 @@ use std::time::Duration;
 
 /// Struct returned by DiagnosticSessionControl (0x10)
 #[derive(Debug, Copy, Clone, Eq, PartialEq)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub struct SessionParameterRecord {
     /// Performance requirement for the server (i.e. the ECU) to start with th response message after the reception of a request message.
     pub p2_server_max: Duration,