BinaryEx 0.4.0

dotnet add package BinaryEx --version 0.4.0
                    
NuGet\Install-Package BinaryEx -Version 0.4.0
                    
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="BinaryEx" Version="0.4.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="BinaryEx" Version="0.4.0" />
                    
Directory.Packages.props
<PackageReference Include="BinaryEx" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add BinaryEx --version 0.4.0
                    
#r "nuget: BinaryEx, 0.4.0"
                    
#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.
#addin nuget:?package=BinaryEx&version=0.4.0
                    
Install BinaryEx as a Cake Addin
#tool nuget:?package=BinaryEx&version=0.4.0
                    
Install BinaryEx as a Cake Tool

BinaryEx

BinaryEx on NuGet

Fast C# Extension functions for reading and writing binary data. Easy to use, high performance, with no allocation!

Combines the ease of use of streams with the performance of BinaryPrimatives, this library was originally built for high performance under unity but is very versitile in many other environments.

Features:

  • Extention method based apis makes it very easy to read or write data anywhere.
  • Direct position indexing, or ref offset based apis to automatically keep track of the buffer offset!
  • Directly write values to the following buffer types:
    • byte[], Span<byte>, byte*, Stream
  • Directly read values from the following buffer types:
    • byte[], Span<byte>, ReadOnlySpan<byte>, byte*, Stream
  • Serialize data using the following types:
    • byte, sbyte, short, ushort, int, uint, long, ulong, float, double
  • Operate on data as either Big Endian, or Little Endian

Benchmarks between BinaryPrimatives, BitConverter, BinaryReader and BinaryEx coming soon.

Currently planned features for upcoming releases:

  • Support for IBufferWriter for writing, and ReadOnlySequence for reading
  • Support for Memory<T> ? (need to work out the performance overhead over just using spans if it would be worth it)
  • Writing APIs for strings, UUID

I have extensively benchmarked this library to try and get the best performance possible from all runtimes.

Usage instructions

Here is a basic example of reading and writing to an array:

using BinaryEx;
int numberCount = 32;
byte[] array = new byte[numberCount * sizeof(int)];

int pos = 0;
// Write 32 ints into the array in big endian byte order
for (int i = 0; i < numberCount; ++i)
{
    array.WriteInt32BE(i, ref pos);
}

pos = 0;
// Read the arrays back from the array
for (int i = 0; i < numberCount; ++i)
{
    int n = array.ReadInt32BE(ref pos);
}
Product 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.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.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 is compatible. 
.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.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.4.0 314 1/17/2024
0.3.0 144 1/10/2024
0.2.0 165 12/23/2023
0.1.0 361 3/23/2023