BitSerializer 1.0.1
There is a newer version of this package available.
See the version list below for details.
See the version list below for details.
dotnet add package BitSerializer --version 1.0.1
NuGet\Install-Package BitSerializer -Version 1.0.1
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="BitSerializer" Version="1.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add BitSerializer --version 1.0.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: BitSerializer, 1.0.1"
#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 BitSerializer as a Cake Addin #addin nuget:?package=BitSerializer&version=1.0.1 // Install BitSerializer as a Cake Tool #tool nuget:?package=BitSerializer&version=1.0.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Key features
- Easy to use
- Lightweight
- Fast serialization and deserialization (see Performance section)
- Supports nested schema types
- No external compilator required
- Classes act as a serialization schema
Performance
How to use?
Schema definition
The first step is to define a schema class containing the fields you want to serialize. It specifies in which order to serialize your data and deserialize it later.
Example
public class DataPacket
{
// Fields or properties you want to serialize
public int Id { get; set; }
public byte[] Payload { get; set; }
// Remember to always include a parameterless constructor, otherwise the deserializer won't be able
// to create a new instance of the class.
public DataPacket()
{
}
public DataPacket(int id, byte[] payload)
{
Id = id;
Payload = payload;
}
}
Serialization
Create an instance of the schema class created earlier and pass it to the BinarySerializer.Serialize
method.
Example
DataPacket packet = new DataPacket(
id: 1,
payload: new byte[] { 0x1, 0x2, 0x3 }
);
byte[] bytes = BinarySerializer.Serialize(packet);
Deserialization
Pass the bytes returned by the BinarySerializer.Serialize
to the BinarySerializer.Deserialize<T>
method specifying the type of the schema class.
Example
DataPacket packet = BinarySerializer.Deserialize<DataPacket>(bytes);
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. 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. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
.NETStandard 2.0
- No dependencies.
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.