OatmealDome.BinaryData
1.0.0
dotnet add package OatmealDome.BinaryData --version 1.0.0
NuGet\Install-Package OatmealDome.BinaryData -Version 1.0.0
<PackageReference Include="OatmealDome.BinaryData" Version="1.0.0" />
paket add OatmealDome.BinaryData --version 1.0.0
#r "nuget: OatmealDome.BinaryData, 1.0.0"
// Install OatmealDome.BinaryData as a Cake Addin #addin nuget:?package=OatmealDome.BinaryData&version=1.0.0 // Install OatmealDome.BinaryData as a Cake Tool #tool nuget:?package=OatmealDome.BinaryData&version=1.0.0
OatmealDome's BinaryData Fork
This is a fork of Syroot.BinaryData on version 4.0.4.
A bunch of libraries and programs (for example, Switch Toolbox) use other libraries originally made by Syroot which in turn use BinaryData, and they are very particular about which BinaryData version they use. This complicates things I write which use my preferred BinaryData version in separate parts of the code. Because of this, I decided to fork 4.0.4 so I can change the namespace and version to avoid conflicts.
I also personally dislike the changes made in version 5.0.0+ of the library, and much prefer to use the APIs in 4.0.0.
If you're looking to use Syroot.BinaryData, I recommend you take a look at the latest version and use that instead. This fork is really just for my personal purposes.
Original Readme
When parsing or storing data in binary file formats, the functionality offered by the default .NET BinaryReader
and
BinaryWriter
classes is often insufficient. It lacks support for a different byte order than the system one, and
cannot parse specific string or date formats (most prominently, 0-terminated strings instead of the default
variable-length prefixed .NET strings).
Further, navigating in binary files is slightly tedious when it is required to skip to another chunk in the file and then navigate back. Also, aligning to specific block sizes might be a common task.
This NuGet package adds all this and more functionality by offering a large set of extension methods for the Stream
class of .NET 4.5 and .NET Standard 2.0. Additionally, serializing and deserializing complete class hierarchies can be
done immediately.
Additionally, BinaryDataReader
and BinaryDataWriter
classes are provided, usable like the default .NET
BinaryReader
and BinaryWriter
so that new functionality can be added almost instantly to existing projects.
Installation
The library is available in the following NuGet packages:
- Syroot.IO.BinaryData (unsigned)
- Syroot.IO.BinaryData.Signed (signed assembly)
Are you using 3.x.x or earlier?
If you used object serialization features, you want to update to 4.x.x:
- Members in pre-4.x.x versions were not read or written in a deterministic order.
- 4.x.x fixes this by serializing members alphabetically or with the given order specified through the new
BinaryMemberAttribute.Order
property. Please consult the wiki page for guidance.
Documentation
- A code-oriented feature tour is available on the wiki.
- Complete MSDN-style API documentation is hosted on docs.syroot.com.
Support
You can ask questions and suggest features on Discord aswell. Feel free to join the BinaryData channel on the Syroot server!
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 | net45 is compatible. net451 was computed. net452 was computed. net46 was computed. 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. |
-
.NETFramework 4.5
- No dependencies.
-
.NETStandard 2.0
- No dependencies.
NuGet packages (1)
Showing the top 1 NuGet packages that depend on OatmealDome.BinaryData:
Package | Downloads |
---|---|
OatmealDome.NinLib.Byaml
.NET library providing loading, saving, and serialization support for the Nintendo BYAML format. |
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
1.0.0 | 266 | 4/24/2024 |
Initial release.