https://github.com/fb55/binopsy
Reimplementation of binary-parser supporting serialization and streaming
https://github.com/fb55/binopsy
binary-data binary-parser serialization stream
Last synced: 11 months ago
JSON representation
Reimplementation of binary-parser supporting serialization and streaming
- Host: GitHub
- URL: https://github.com/fb55/binopsy
- Owner: fb55
- Created: 2016-03-13T16:49:54.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2024-06-16T22:47:26.000Z (over 1 year ago)
- Last Synced: 2025-02-27T16:48:53.032Z (12 months ago)
- Topics: binary-data, binary-parser, serialization, stream
- Language: JavaScript
- Homepage: https://feedic.com/binopsy/
- Size: 359 KB
- Stars: 10
- Watchers: 5
- Forks: 3
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# `binopsy`
Reimplementation of [keichi/binary-parser](https://github.com/keichi/binary-parser), supporting both streams and serialization.
The API is mainly the same as `binary-parser`'s, with a couple of additions and one removed method.
## Dropped support for `.skip`
Due to undefined behavior, `.skip` is not supported.
As a workaround the `.buffer` method can be used.
## `.stream`
The `.stream` method returns a transform stream that reads incoming data and emits parser results.
The parser instance is looped until the end of the input is reached.
## `.serialize`
As a counterpart to `binary-parser`'s `.parse` method, `.serialize` takes an object and returns a buffer representation of it.
Optionally, an already allowcated buffer can be passed as a second argument.
## `.fixedSizeNest`
`.fixedSizeNest` is a variation of `nest` that ensures the nested parser reads a specific amount of bytes.
Fixed-size nested parsers are the only source of ambiguity remaining while serializing, as missing bytes are simply skipped.
And error is thrown during serialization if the nested parser attempts to write more bytes than the size permits.
## `formatter`s require a `deformatter`
Properties with a specified formatting function need to also provide a `deformatter` function that restores the original value.
## `flatten` option
As a very simple extension, the `flatten` option allows nested parsers to write to the current object.
Its motivation is the aim for a flat output structure after `.choice` calls.
## Bitfields can be (almost) infinitely long
A relaxation from the 32 bit limit of `binary-parser`.
Also, a bug of the original project that leads to the `bit32` method always parsing [a value of `0`](https://github.com/keichi/binary-parser/issues/35) is not present.
__License: MIT__