https://github.com/wangtz0607/serialization

C++20 header-only serialization library
https://github.com/wangtz0607/serialization

Last synced: about 2 months ago
JSON representation

C++20 header-only serialization library

• Host: GitHub
• URL: https://github.com/wangtz0607/serialization
• Owner: wangtz0607
• License: mit
• Created: 2024-08-08T08:52:26.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-08-11T10:03:26.000Z (5 months ago)
• Last Synced: 2024-08-12T10:56:00.535Z (5 months ago)
• Language: C++
• Size: 22.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Serialization

C++20 header-only serialization library.

## Examples

```cpp

#include 

#include 

#include 

#include 

#include "serialization.h"

#include "serialization/fundamental.h"

#include "serialization/string.h"

#include "serialization/unordered_map.h"

using namespace serialization;

int main() {

    std::unordered_map original{

        {"one", 1},

        {"two", 2},

        {"three", 3},

    };

    SerializationStream ss;

    ss << original;

    std::unordered_map deserialized;

    DeserializationStream ds(ss.data());

    ds >> deserialized;

    assert(deserialized == original);

    return 0;

}

```

```cpp

#include 

#include 

#include "serialization.h"

#include "serialization/fundamental.h"

#include "serialization/string.h"

using namespace serialization;

struct Person {

    std::string name;

    int age;

};

bool operator==(const Person &lhs, const Person &rhs) {

    return lhs.name == rhs.name && lhs.age == rhs.age;

}

SerializationStream &operator<<(SerializationStream &ss, const Person &person) {

    return ss << person.name << person.age;

}

DeserializationStream &operator>>(DeserializationStream &ds, Person &person) {

    return ds >> person.name >> person.age;

}

int main() {

    Person original{"Alice", 18};

    SerializationStream ss;

    ss << original;

    Person deserialized;

    DeserializationStream ds(ss.data());

    ds >> deserialized;

    assert(deserialized == original);

    return 0;

}

```

## API

### `serialization.h`

Definition of `SerializationStream`, `DeserializationStream`, and related exceptions.

### `serialization/fundamental.h`

Serialization and deserialization support for integral and floating-point types.

### `serialization/compound.h`

Serialization and deserialization support for C-style arrays.

### `serialization/enum.h`

Serialization and deserialization support for enumerations (both scoped and unscoped).

### `serialization/*.h`

Serialization and deserialization support for STL types.

| STL Types | Header |

| - | - |

| `std::array` | `serialization/array.h` |

| `std::basic_string` | `serialization/string.h` |

| `std::vector` | `serialization/vector.h` |

| `std::deque` | `serialization/deque.h` |

| `std::list` | `serialization/list.h` |

| `std::set`, `std::multiset` | `serialization/set.h` |

| `std::map`, `std::multimap` | `serialization/map.h` |

| `std::unordered_set`, `std::unordered_multiset` | `serialization/unordered_set.h` |

| `std::unordered_map`, `std::unordered_multimap` | `serialization/unordered_map.h` |

| `std::pair` | `serialization/utility.h` |

| `std::tuple` | `serialization/tuple.h` |

| `std::complex` | `serialization/complex.h` |

| `std::optional` | `serialization/optional.h` |

| `std::variant` | `serialization/variant.h` |

## Integration

Simply add `include` to the compiler's include path.

Alternatively, use CMake:

```cmake

find_package(serialization CONFIG REQUIRED)

target_link_libraries(your_target PRIVATE serialization::serialization)

```

## License

Serialization is licensed under the [MIT license](https://opensource.org/license/MIT).