Hexarc.Borsh 0.0.10

Hexarc Borsh

Hexarc.Borsh is .NET implementation of the Binary Object Representation Serializer for Hashing format.

Current status: 🚧 Under development 🚧

Getting started

Install the package with the NuGet CLI:

dotnet add package Hexarc.Borsh

Reference the Hexarc.Borsh namespace in your code:

using Hexarc.Borsh;

Serialize and deserialize .NET objects via the BorshSerializer class:

public class Point
{
    public Int32 X { get; init; }
    public Int32 Y { get; init; }
    public Int32 Z { get; init; }
}

var point = new Point() { X = 5, Y = 10, Z = 20 };

var raw = BorshSerializer.Serialize(point);
var restored = BorshSerializer.Deserialize(raw);

Features

Limited count of the .NET types are currently supported:

• Byte, SByte, Boolean, Int16, UInt16, Int32, UInt32, Int64, UInt64
• Single, Double
• Nullable<T>
• Enum
• String
• Arrays as T[]
• HashSet<T>
• Hexarc.Borsh.Option<T>
• POCO like user defined classes

All other types are not supported at the moment but already planned.

Another important notice that Borsh is mostly designed to support the Rust type system. So null reference values are not supported in .NET implementation. Please use the special Hexarc.Borsh.Option<T> type instead of .NET nullable reference types: So this example:

public class PersonDetails
{
    public String? FirstName { get; init; }
    public String? LastName { get; init; }
}

should be rewritten as:

public class PersonDetails
{
    public Option<String> FirstName { get; init; }
    public Option<String> LastName { get; init; }
}

Acknowledgments

Built with JetBrains tools for Open Source projects.

License

MIT © Max Koverdyaev