feat: added serializers #2756

SharonIV0x86 · 2024-10-04T19:04:00Z

Pull Request Title: Add Serializer and Deserializer Classes for Binary Serialization of Primitives and Strings

Description:

This pull request introduces a Serializer and Deserializer class for the serialization and deserialization of fundamental types such as int, double, char, and std::string in binary format. The feature supports both serialization of primitive types and strings, ensuring safe handling of binary data.

For primitives like int, float, and double, serialization is straightforward. However, serializing or deserializing std::string is more challenging due to its dynamic size and the absence of a delimiter (like null termination in C-style strings), which means we wouldn’t know how much to read or write.

To address this, the following approach is used:

Serializing:

Writing the size of the string immediately before the string data.
Adding a delimiter | at the end of the string to signify its boundary.

Deserializing:

Reading the size of the string before reading the actual string data to know how much to read.
Reading the string until the delimiter | is encountered.

Note: You can replace | with any other delimiter of your choice if needed.

Checklist:

Added a description of the change.
File name matches File Name Guidelines.
Added tests and example; tests must pass.
Added documentation to make the program self-explanatory and educational, following Doxygen guidelines.
Relevant documentation/comments are changed or added.
PR title follows semantic commit guidelines.
Searched for previous suggestions before making a new one to avoid duplication.
I acknowledge that all my contributions will be made under the project's license.

others/serialization.cpp

realstealthninja · 2024-10-05T10:32:14Z

Hey, thank you for the contribution question is this for hacktoberfest?

others/serialization.cpp

realstealthninja · 2024-10-05T10:37:58Z

others/serialization.cpp

+    }
+
+    /**
+     * Serializes a string to a binary file.


Suggested change

* Serializes a string to a binary file.

* @brief Serializes a string to a binary file.

still needs to be resolved

realstealthninja · 2024-10-05T10:38:18Z

others/serialization.cpp

+     * @param out The output stream (std::ofstream).
+     * @param data The string to be serialized.
+     *
+     * The string is serialized by first storing its length, followed by the


Suggested change

* The string is serialized by first storing its length, followed by the

* @note The string is serialized by first storing its length, followed by the

still needs to be resolved

others/serialization.cpp

realstealthninja · 2024-10-05T10:50:59Z

others/serialization.cpp

+
+    if (!outFile || !inFile) {
+        std::cerr << "Error opening files.\n";
+        return 1;


main function should have nothing except
a call to the test function
and a return 0;
thus move all the tests from here to the test function

realstealthninja · 2024-10-05T10:51:19Z

others/serialization.cpp

+ * Deserializer.
+ */
+
+void runTests() {


Suggested change

void runTests() {

void tests() {

realstealthninja · 2024-10-05T10:52:15Z

others/serialization.cpp

+/**
+ * @brief A test suite to perform extensive testing on the Serializer and
+ * Deserializer.
+ */
+


Suggested change

/**

* @brief A test suite to perform extensive testing on the Serializer and

* Deserializer.

*/

/**

* @brief self test implementation

* @return void

*/

realstealthninja · 2024-10-05T10:53:06Z

others/serialization.cpp

+    }
+};
+
+void runTests();


tests dont really need to be forward declared just move the definition from the tests at the bottom to here

SharonIV0x86 · 2024-10-16T13:52:16Z

Hey, thank you for the contribution question is this for hacktoberfest?

Yes.

realstealthninja · 2024-10-19T09:38:34Z

others/serialization.cpp

+/**
+ * @file
+ * @brief A simple Serializer and Deserializer utility for fundamental data
+ * types and strings.


you should add more details via a @detail tag and your name with @author tag

others/serialization.cpp

realstealthninja · 2024-10-21T13:22:31Z

others/serialization.cpp

+    }
+
+    /**
+     * Serializes a string to a binary file.


still needs to be resolved

realstealthninja · 2024-10-21T13:22:49Z

others/serialization.cpp

+     * @param out The output stream (std::ofstream).
+     * @param data The string to be serialized.
+     *
+     * The string is serialized by first storing its length, followed by the


still needs to be resolved

others/serialization.cpp

realstealthninja · 2024-10-22T13:48:36Z

others/serialization.cpp

+
+        int intResult;
+        // Deserialize expecting binary data, this should fail
+        Deserializer::deserialize(inFile, intResult);


what is the failure here?

realstealthninja · 2024-10-22T13:49:16Z

others/serialization.cpp

+    try {
+        std::ifstream inFile("non_existent_file.bin", std::ios::binary);
+        if (!inFile) {
+            throw std::runtime_error("Error opening non-existent file.");


why are we checking the errors on the user end the only failures to be checked are the ones raised by the class itself.

realstealthninja · 2024-10-22T13:49:48Z

others/serialization.cpp

+ * @return void
+ */
+void tests() {
+    try {


this shouldnt be wrapped in a try catch loop. Tests should never fail.

others/serialization.cpp

realstealthninja · 2024-10-28T13:02:36Z

others/serialization.cpp

+/** \namespace ciphers
+ * \brief Classes for binary Serialization and Deserialization 
+ */


Suggested change

/** \namespace ciphers

* \brief Classes for binary Serialization and Deserialization

*/

/**

* @namespace serialization

* @brief Classes for binary Serialization and Deserialization

*/

realstealthninja · 2024-10-28T13:02:58Z

others/serialization.cpp

+/** \namespace ciphers
+ * \brief Classes for binary Serialization and Deserialization 
+ */
+namespace Serialization {


Suggested change

namespace Serialization {

namespace serialization {

github-actions · 2024-12-12T00:14:36Z

This pull request has been automatically marked as abandoned because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

github-actions · 2024-12-20T00:13:19Z

Please ping one of the maintainers once you commit the changes requested or make improvements on the code. If this is not the case and you need some help, feel free to ask for help in our Gitter channel or our Discord server. Thank you for your contributions!

SharonIV0x86 requested review from Panquesito7 and realstealthninja as code owners October 4, 2024 19:04

realstealthninja added the awaiting review pull request is waiting to be reviewed label Oct 4, 2024

realstealthninja requested changes Oct 4, 2024

View reviewed changes

others/serialization.cpp Outdated Show resolved Hide resolved

others/serialization.cpp Show resolved Hide resolved

realstealthninja added awaiting modification Do not merge until modifications are made and removed awaiting review pull request is waiting to be reviewed labels Oct 5, 2024

SharonIV0x86 force-pushed the master branch from 2b8f59a to ca3f63e Compare October 5, 2024 06:32

SharonIV0x86 requested a review from realstealthninja October 5, 2024 06:35

realstealthninja requested changes Oct 5, 2024

View reviewed changes

SharonIV0x86 added 4 commits October 16, 2024 19:19

feat: added serializers

0b19d86

fix: added assertions in test function.

6e1f86d

fix: added test assertions.

79539ae

fix: made requested changes.

4df4977

SharonIV0x86 force-pushed the master branch from 3f3f524 to 4df4977 Compare October 16, 2024 13:51

SharonIV0x86 requested a review from realstealthninja October 16, 2024 13:52

fix: replaced ssize_t with std::uint32_t

8b8f915

realstealthninja added the hacktoberfest label Oct 19, 2024

realstealthninja requested changes Oct 19, 2024

View reviewed changes

fix: made required changes.

afb2b7a

SharonIV0x86 requested a review from realstealthninja October 20, 2024 12:53

realstealthninja requested changes Oct 21, 2024

View reviewed changes

fix: added missing @brief

a436849

SharonIV0x86 requested a review from realstealthninja October 21, 2024 13:43

realstealthninja requested changes Oct 22, 2024

View reviewed changes

realstealthninja and others added 2 commits October 22, 2024 19:23

docs: add documentation to main

447d463

fix: made required changes

33573a9

realstealthninja requested changes Oct 23, 2024

View reviewed changes

others/serialization.cpp Show resolved Hide resolved

SharonIV0x86 requested a review from realstealthninja October 26, 2024 06:23

fix: added Serialization namespace

155df97

realstealthninja requested changes Oct 28, 2024

View reviewed changes

fix: fixed namespace issues

4e4089c

SharonIV0x86 requested a review from realstealthninja October 29, 2024 15:08

github-actions bot added the stale Author has not responded to the comments for over 2 weeks label Dec 12, 2024

github-actions bot closed this Dec 20, 2024

	* Serializes a string to a binary file.
	* @brief Serializes a string to a binary file.

	* The string is serialized by first storing its length, followed by the
	* @note The string is serialized by first storing its length, followed by the

Uh oh!

feat: added serializers #2756

feat: added serializers #2756

Uh oh!

Conversation

SharonIV0x86 commented Oct 4, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Serializing:

Deserializing:

Uh oh!

Uh oh!

Uh oh!

realstealthninja commented Oct 5, 2024

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

SharonIV0x86 commented Oct 16, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Dec 12, 2024

Uh oh!

github-actions bot commented Dec 20, 2024

Uh oh!

Uh oh!

SharonIV0x86 commented Oct 4, 2024 •

edited

Loading