You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@plc4x.apache.org by jf...@apache.org on 2022/06/02 12:26:33 UTC

[plc4x] branch feature/plc4rs updated: Refactoring of Message trait

This is an automated email from the ASF dual-hosted git repository.

jfeinauer pushed a commit to branch feature/plc4rs
in repository https://gitbox.apache.org/repos/asf/plc4x.git


The following commit(s) were added to refs/heads/feature/plc4rs by this push:
     new 3b5c52d373 Refactoring of Message trait
3b5c52d373 is described below

commit 3b5c52d373384eef205b8b8c86a2d1fc19fcf095
Author: julian <j....@pragmaticminds.de>
AuthorDate: Thu Jun 2 14:26:27 2022 +0200

    Refactoring of Message trait
---
 plc4rust/src/lib.rs                                | 22 +++++++++-
 plc4rust/src/modbus/driver_type.rs                 |  3 +-
 plc4rust/src/modbus/mod.rs                         |  2 +-
 plc4rust/src/modbus/modbus_adu.rs                  | 50 ++++++++++++++--------
 plc4rust/src/modbus/modbus_pdu.rs                  | 14 +++++-
 .../modbus_pdu_read_file_record_request_item.rs    |  3 +-
 .../modbus_pdu_write_file_record_response_item.rs  |  3 +-
 7 files changed, 70 insertions(+), 27 deletions(-)

diff --git a/plc4rust/src/lib.rs b/plc4rust/src/lib.rs
index 60b7b8be10..82f19e3b37 100644
--- a/plc4rust/src/lib.rs
+++ b/plc4rust/src/lib.rs
@@ -1,6 +1,7 @@
 use std::any::Any;
 use std::collections::HashMap;
-use std::io::{Read, Write};
+use std::io::{Error, Read, Write};
+use std::io::ErrorKind::InvalidInput;
 
 use crate::read_buffer::ReadBuffer;
 use crate::write_buffer::WriteBuffer;
@@ -17,11 +18,28 @@ pub enum Endianess {
 
 trait Message {
     type M;
+    type O;
 
     fn get_length(&self) -> u32;
 
     fn serialize<T: Write>(&self, writer: &mut WriteBuffer<T>) -> Result<usize, std::io::Error>;
-    fn deserialize<T: Read>(reader: &mut ReadBuffer<T>) -> Result<Self::M, std::io::Error>;
+
+    fn _deserialize<T: Read>(reader: &mut ReadBuffer<T>) -> Result<Self::M, std::io::Error>;
+
+    fn deserialize<T: Read>(reader: &mut ReadBuffer<T>, parameter: Option<Self::O>) -> Result<Self::M, std::io::Error> {
+        match parameter {
+            None => {
+                Self::_deserialize(reader)
+            }
+            Some(_) => {
+                Err(Error::new(InvalidInput, "not implemented!"))
+            }
+        }
+    }
+
+}
+
+trait ParametrizedMessage: Message {
 
 }
 
diff --git a/plc4rust/src/modbus/driver_type.rs b/plc4rust/src/modbus/driver_type.rs
index c4365e296a..89c193862f 100644
--- a/plc4rust/src/modbus/driver_type.rs
+++ b/plc4rust/src/modbus/driver_type.rs
@@ -53,6 +53,7 @@ impl Into<u8> for DriverType {
 
 impl Message for DriverType {
     type M = DriverType;
+    type O = u8;
 
     fn get_length(&self) -> u32 {
         1
@@ -62,7 +63,7 @@ impl Message for DriverType {
         writer.write_u8((*self).into())
     }
 
-    fn deserialize<T: Read>(reader: &mut ReadBuffer<T>) -> Result<Self::M, Error> {
+    fn _deserialize<T: Read>(reader: &mut ReadBuffer<T>) -> Result<Self::M, Error> {
         let result = reader.read_u8()?;
         match DriverType::try_from(result) {
             Ok(result) => {
diff --git a/plc4rust/src/modbus/mod.rs b/plc4rust/src/modbus/mod.rs
index e02752dcf4..52405f72b5 100644
--- a/plc4rust/src/modbus/mod.rs
+++ b/plc4rust/src/modbus/mod.rs
@@ -45,7 +45,7 @@ mod test {
         let bytes = writer.writer.clone();
         let mut reader = ReadBuffer::new(Endianess::BigEndian, &*bytes);
 
-        if let Ok(msg) = ModbusPDUWriteFileRecordResponseItem::deserialize(&mut reader) {
+        if let Ok(msg) = ModbusPDUWriteFileRecordResponseItem::deserialize(&mut reader, None) {
             assert_eq!(message, msg);
         } else {
             assert!(false);
diff --git a/plc4rust/src/modbus/modbus_adu.rs b/plc4rust/src/modbus/modbus_adu.rs
index 3c607ca85e..7cc775b140 100644
--- a/plc4rust/src/modbus/modbus_adu.rs
+++ b/plc4rust/src/modbus/modbus_adu.rs
@@ -49,26 +49,14 @@ pub enum ModbusADU {
     ModbusRtuADU(ModbusRtuADU),
 }
 
-impl ModbusADU {
-
-    fn deserialize_special<T: Read>(reader: &mut ReadBuffer<T>, driver_type: DriverType, bit_response: bool) -> Result<ModbusADU, Error> {
-        match driver_type {
-            DriverType::MODBUS_TCP => {
-                Ok(ModbusADU::ModbusTcpADU(ModbusTcpADU::deserialize(reader)?))
-            }
-            DriverType::MODBUS_RTU => {
-                Ok(ModbusADU::ModbusRtuADU(ModbusRtuADU::deserialize(reader)?))
-            }
-            _ => {
-                Err(Error::new(InvalidInput, format!("Unable to deserialize from {:?}, {:?}", driver_type, bit_response)))
-            }
-        }
-    }
-
+pub struct ModbusADUOptions {
+    driver_type: DriverType,
+    response: bool
 }
 
 impl Message for ModbusADU {
     type M = ModbusADU;
+    type O = ModbusADUOptions;
 
     fn get_length(&self) -> u32 {
         todo!()
@@ -78,9 +66,31 @@ impl Message for ModbusADU {
         todo!()
     }
 
-    fn deserialize<T: Read>(reader: &mut ReadBuffer<T>) -> Result<Self::M, Error> {
+    fn _deserialize<T: Read>(reader: &mut ReadBuffer<T>) -> Result<Self::M, Error> {
         Err(Error::new(InvalidInput, "Cannot parse directly!"))
     }
+
+    fn deserialize<T: Read>(reader: &mut ReadBuffer<T>, parameter: Option<Self::O>) -> Result<Self::M, Error> {
+        match parameter {
+            Some(parameter) => {
+                match parameter.driver_type {
+                    DriverType::MODBUS_TCP => {
+                        Ok(ModbusADU::ModbusTcpADU(ModbusTcpADU::deserialize::<T>(reader, None)?))
+                    }
+                    DriverType::MODBUS_RTU => {
+                        Ok(ModbusADU::ModbusRtuADU(ModbusRtuADU::deserialize::<T>(reader, None)?))
+                    }
+                    _ => {
+                        Err(Error::new(InvalidInput, format!("Unable to deserialize from {:?}, {:?}", parameter.driver_type, parameter.response)))
+                    }
+                }
+            }
+            _ => {
+                Err(Error::new(InvalidInput, "Unable to construct object"))
+            }
+        }
+
+    }
 }
 
 pub struct ModbusTcpADU {
@@ -98,6 +108,7 @@ impl ModbusTcpADU {
 
 impl Message for ModbusTcpADU {
     type M = ModbusTcpADU;
+    type O = u8;
 
     fn get_length(&self) -> u32 {
         todo!()
@@ -107,7 +118,7 @@ impl Message for ModbusTcpADU {
         todo!()
     }
 
-    fn deserialize<T: Read>(reader: &mut ReadBuffer<T>) -> Result<Self::M, Error> {
+    fn _deserialize<T: Read>(reader: &mut ReadBuffer<T>) -> Result<Self::M, Error> {
         todo!()
     }
 }
@@ -118,6 +129,7 @@ pub struct ModbusRtuADU {
 
 impl Message for ModbusRtuADU {
     type M = ModbusRtuADU;
+    type O = u8;
 
     fn get_length(&self) -> u32 {
         todo!()
@@ -127,7 +139,7 @@ impl Message for ModbusRtuADU {
         todo!()
     }
 
-    fn deserialize<T: Read>(reader: &mut ReadBuffer<T>) -> Result<Self::M, Error> {
+    fn _deserialize<T: Read>(reader: &mut ReadBuffer<T>) -> Result<Self::M, Error> {
         todo!()
     }
 }
\ No newline at end of file
diff --git a/plc4rust/src/modbus/modbus_pdu.rs b/plc4rust/src/modbus/modbus_pdu.rs
index 14bf4a6b3b..e0ec9843f7 100644
--- a/plc4rust/src/modbus/modbus_pdu.rs
+++ b/plc4rust/src/modbus/modbus_pdu.rs
@@ -204,8 +204,17 @@ pub enum ModbusPDU {
     ModbusPDUError(ModbusPDUError)
 }
 
+impl ModbusPDU {
+
+    fn deserialize_special<T: Read>(reader: &mut ReadBuffer<T>, bit_response: bool) -> Result<ModbusPDU, Error> {
+        todo!()
+    }
+
+}
+
 impl Message for ModbusPDU {
     type M = ModbusPDU;
+    type O = u8;
 
     fn get_length(&self) -> u32 {
         match self {
@@ -219,7 +228,7 @@ impl Message for ModbusPDU {
         todo!()
     }
 
-    fn deserialize<T: Read>(reader: &mut ReadBuffer<T>) -> Result<Self::M, Error> {
+    fn _deserialize<T: Read>(reader: &mut ReadBuffer<T>) -> Result<Self::M, Error> {
         todo!()
     }
 }
@@ -230,6 +239,7 @@ pub struct ModbusPDUError {
 
 impl Message for ModbusPDUError {
     type M = ModbusPDUError;
+    type O = u8;
 
     fn get_length(&self) -> u32 {
         todo!()
@@ -239,7 +249,7 @@ impl Message for ModbusPDUError {
         todo!()
     }
 
-    fn deserialize<T: Read>(reader: &mut ReadBuffer<T>) -> Result<Self::M, Error> {
+    fn _deserialize<T: Read>(reader: &mut ReadBuffer<T>) -> Result<Self::M, Error> {
         todo!()
     }
 }
\ No newline at end of file
diff --git a/plc4rust/src/modbus/modbus_pdu_read_file_record_request_item.rs b/plc4rust/src/modbus/modbus_pdu_read_file_record_request_item.rs
index d99be81794..c7587d2d9b 100644
--- a/plc4rust/src/modbus/modbus_pdu_read_file_record_request_item.rs
+++ b/plc4rust/src/modbus/modbus_pdu_read_file_record_request_item.rs
@@ -17,6 +17,7 @@ pub struct ModbusPDUReadFileRecordRequestItem {
 
 impl Message for ModbusPDUReadFileRecordRequestItem {
     type M = ModbusPDUReadFileRecordRequestItem;
+    type O = u8;
 
     fn get_length(&self) -> u32 {
         56
@@ -30,7 +31,7 @@ impl Message for ModbusPDUReadFileRecordRequestItem {
         Ok(size)
     }
 
-    fn deserialize<T: Read>(reader: &mut ReadBuffer<T>) -> Result<Self::M, std::io::Error> {
+    fn _deserialize<T: Read>(reader: &mut ReadBuffer<T>) -> Result<Self::M, std::io::Error> {
         let reference_type = reader.read_u8()?;
         let file_number = reader.read_u16()?;
         let record_number = reader.read_u16()?;
diff --git a/plc4rust/src/modbus/modbus_pdu_write_file_record_response_item.rs b/plc4rust/src/modbus/modbus_pdu_write_file_record_response_item.rs
index 4dce6b73e4..320714d4ca 100644
--- a/plc4rust/src/modbus/modbus_pdu_write_file_record_response_item.rs
+++ b/plc4rust/src/modbus/modbus_pdu_write_file_record_response_item.rs
@@ -24,6 +24,7 @@ impl ModbusPDUWriteFileRecordResponseItem {
 
 impl Message for ModbusPDUWriteFileRecordResponseItem {
     type M = ModbusPDUWriteFileRecordResponseItem;
+    type O = u8;
 
     fn get_length(&self) -> u32 {
         56 + self.record_data.len() as u32
@@ -38,7 +39,7 @@ impl Message for ModbusPDUWriteFileRecordResponseItem {
         Ok(size)
     }
 
-    fn deserialize<T: Read>(reader: &mut ReadBuffer<T>) -> Result<Self::M, std::io::Error> {
+    fn _deserialize<T: Read>(reader: &mut ReadBuffer<T>) -> Result<Self::M, std::io::Error> {
         let reference_type = reader.read_u8()?;
         let file_number = reader.read_u16()?;
         let record_number = reader.read_u16()?;