SerialBox 5.0.3

dotnet add package SerialBox --version 5.0.3                
NuGet\Install-Package SerialBox -Version 5.0.3                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="SerialBox" Version="5.0.3" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add SerialBox --version 5.0.3                
#r "nuget: SerialBox, 5.0.3"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install SerialBox as a Cake Addin
#addin nuget:?package=SerialBox&version=5.0.3

// Install SerialBox as a Cake Tool
#tool nuget:?package=SerialBox&version=5.0.3                

SerialBox

.NET Publish

SerialBox is a library designed to simplify serialization in .Net. By default it supports XML and JSON but can be expanded upon to support other serialization targets as well.

Basic Usage

The library can be initialized by registering it with your IoC container during startup. Example code:

ServiceProvider? ServiceProvider = new ServiceCollection().RegisterSerialBox()?.BuildServiceProvider();

or

ServiceProvider? ServiceProvider = new ServiceCollection().AddCanisterModules()?.BuildServiceProvider();

As the library supports Canister Modules.

This line is required prior to using the extension methods for the first time. Once it is set up, you can call the extension methods provided:

[DataContract]
public class Temp
{
    [DataMember(Name = "A", Order = 1)]
    public int A { get; set; }
}

...

var TestObj = new Temp() { A = 100 };
string Value = TestObj.Serialize<string, Temp>();
Temp TestObj2 = Value.Deserialize<Temp, string>();

The Serialize function takes the serialization type as a parameter. If one is not passed in, it defaults to JSON. This parameter can either be the MIME type for the serialization type as a string or it can be a SerializationType object. The Deserialize function acts in the same manner.

Adding Serialization Types

The system comes with JSON and XML serialization, however you may wish to add other targets such as binary. In order to do this all that you need to do is create a class that inherits from ISerializer<T>:

public class MySerializer : ISerializer<byte[]>
{
    public string ContentType => "application/octet-stream";
	
	public string FileType => ".blob";
	
	public string Name => "Binary";
	
	public object Deserialize(Type objectType, byte[] data) { ... }
	
	public byte[] Serialize(Type objectType, object data) { ... }
}

After the class is created, the system will automatically pick it up and use it.

Overriding Serialization Types

By default the system uses the built in JSON and XML providers in .Net. However it is possible to override these by simply creating a class that inherits from ISerializer<T> and setting the correct ContentType to match the one that you wish to override. For instance to override the JSON provider with your own you would do the following:

public class MySerializer : ISerializer<string>
{
    public string ContentType => "application/json";
	
	public string FileType => ".json";
	
	public string Name => "JSON";
	
	public object Deserialize(Type objectType, string data) { ... }
	
	public string Serialize(Type objectType, object data) { ... }
}

After the class is created, the system will automatically pick it up and use it.

Installation

The library is available via Nuget with the package name "SerialBox". To install it run the following command in the Package Manager Console:

Install-Package SerialBox

Build Process

In order to build the library you will require the following as a minimum:

  1. Visual Studio 2022

Other than that, just clone the project and you should be able to load the solution and build without too much effort.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 is compatible. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (2)

Showing the top 2 NuGet packages that depend on SerialBox:

Package Downloads
TaskMaster

TaskMaster is a simple library used to manage sets of fire and forget tasks that need to run after specific dates/times.

TestFountain

TestFountain is a set of addons/extensions for xUnit.net to help with things like data generation.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
5.0.3 219 12/9/2024
5.0.2 269 11/24/2024
5.0.1 80 11/24/2024
5.0.0 111 11/19/2024
4.0.44 190 11/14/2024
4.0.43 218 11/11/2024
4.0.42 326 11/4/2024
4.0.41 245 10/29/2024
4.0.40 111 10/29/2024
4.0.39 295 10/14/2024
4.0.38 230 10/9/2024
4.0.37 1,016 8/22/2024
4.0.36 492 8/1/2024
4.0.35 753 6/25/2024
4.0.34 354 6/17/2024
4.0.33 907 5/6/2024
4.0.32 230 5/1/2024
4.0.31 181 4/30/2024
4.0.30 175 4/29/2024
4.0.29 684 3/28/2024
4.0.28 322 3/14/2024
4.0.27 226 3/13/2024
4.0.26 482 3/5/2024
4.0.25 258 3/4/2024
4.0.24 506 2/26/2024
4.0.23 427 2/21/2024
4.0.22 307 2/19/2024
4.0.21 879 2/2/2024
4.0.20 501 1/29/2024
4.0.19 533 1/19/2024
4.0.18 1,306 12/11/2023
4.0.17 734 11/17/2023
4.0.16 487 11/16/2023
4.0.15 782 11/6/2023
4.0.14 717 10/30/2023
4.0.13 1,107 9/18/2023
4.0.12 778 9/11/2023
4.0.11 650 9/5/2023
4.0.10 471 9/4/2023
4.0.9 618 8/31/2023
4.0.8 519 8/30/2023
4.0.7 573 8/29/2023
4.0.6 552 8/28/2023
4.0.5 1,107 8/8/2023
4.0.4 616 8/7/2023
4.0.3 1,150 7/13/2023
4.0.2 544 7/12/2023
4.0.1 568 7/10/2023
4.0.0 799 12/12/2022
3.0.12 891 6/10/2022
3.0.8 1,787 1/11/2022
3.0.7 1,004 1/10/2022
3.0.5 1,691 1/6/2021
3.0.3 1,633 9/13/2020
3.0.2 1,726 3/25/2020
3.0.1 3,190 12/23/2019
2.0.2 3,290 6/1/2018
2.0.1 1,330 5/22/2018
2.0.0 2,580 1/2/2018
1.0.8 4,367 5/17/2017
1.0.7 1,363 3/22/2017
1.0.6 1,454 1/24/2017
1.0.5 1,504 12/9/2016
1.0.4 1,400 11/22/2016
1.0.3 1,423 11/21/2016
1.0.2 1,447 11/21/2016
1.0.1 1,499 11/21/2016