Giter VIP home page Giter VIP logo

binarydata's Introduction

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:

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

Support

You can ask questions and suggest features on Discord aswell. Feel free to join the BinaryData channel on the Syroot server!

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.