SerializIt 0.5.0

<p align="center"> <img src ="https://raw.githubusercontent.com/KhaosCoders/SerializIt/master/Art/Icon.png" width=200 /> </p>

SerializIt

A super fast serializer using Roslyn SourceGenerators instead of reflection

Only supports serialization, no deserialization!

Supported Serializers

• JSON
• YAML
• (basic) XML

Installation

You can find this package on nuget.org.

Install SerializIt using Package Manager Console:

Install-Package SerializIt

Or a terminal:

dotnet add package SerializIt 

Usage

Create a model you want to serialize.
Then create a partial serialization context like this

using SerializIt;
using Samples.Model;

namespace Samples
{
    [Serializer(ESerializers.Yaml)]
    [YamlOptions(indentChars: "  ")]
    [SerializeType(typeof(RootElement))]
    [SerializeType(typeof(Container))]
    [SerializeType(typeof(Info))]
    internal partial class YamlContext { }
}

This context will be augmented with a serializer for each defined type.

Call the SerializeDocument (or SerializeElement) method to serialize an object instance.

// var root = new RootElement();

var serializeIt = new YamlContext();
string text = serializeIt.RootElement.SerializeDocument(root);

Take the Samples project in this repo as an example.

Serialization should be super fast!

Benchmarks

This Benchmark compares SerializIt JSON, YAML and XML serialization with other common libraries, like Tinyhand, System.Text.Json, YamlDotNet and System.Xml.Serialization. This benchmark was run on my HP Notebook (16GB Ram, Intel i7-8565U, SSD).

Conclusion

SerializIt is fast. But, if you want to serialize to and from JSON your better of with the Source Generators in System.Text.Json. When you're after YAML or XML serialization however, SerializIt is your best option. It delivers much faster serialization to these formats, than the common libraries this benchmark was performed with.

Remarks

SerializIt does only serialize object. There is no de-serialization for now. So if you need to de-serialize some YAML or XML you're again better of with the mentioned libraries, as they offer de-serialization, too. Moreover, the XML serializer comming with SerializIt is in alpha stage, at best. A lot of work needs to be done, to make it a helpfull serializer.

Features

This serializer supports the following features:

• Formats: JSON, YAML, (basic) XML
• PrettyPrint (JSON / XML): On/Off
• Custom Indentation - Defaults to Tabs
• Can skip defined properties
• Can skip properties with default value
• Can order properties

Pending improvements

[ ] Value Converters (serialize complex data types, like GUID or BitInteger)
[ ] Custom serializers (support custom formats)
[ ] Serializer specific member options (like CDATA for XML or Inline for Yaml & Json)
[ ] XML Namespaces
[ ] XML Attributes

Support this ❤️

If you like my work, please support this project!
Donate via PayPal or become a Sponsor on GitHub