package
A Binary-Object Mapper for JavaScript.
npm install breGitHub-flavored package documentation.
Across all versions.
Download trend unavailable.
Runtime metadata.
Tagged topics.
Latest published Oct 14, 2016
next
A Binary-Object Mapper for JavaScript.
const bre = require("bre")
// Define a Record Type.
const TcpHeader = bre.defineObjectRecord("TcpHeader", [
{type: "uint16", name: "srcPort"},
{type: "uint16", name: "dstPort"},
{type: "uint32", name: "seqNo"},
{type: "uint32", name: "ackNo"},
{type: "bit4", name: "dataOffset"},
{skip: 6},
{type: "bit1", name: "urgCode"},
{type: "bit1", name: "ackCode"},
{type: "bit1", name:
bre's record object is just the wrapper of an ArrayBuffer object.
$ npm install --save bre>=4.0.0Like C struct, bre allows accessing binary data as a structure fastly.
The following steps are the basic usage of bre:
const bre = require("bre")
const ExampleRecord = bre.defineObjectRecord("ExampleRecord", [
{type: "uint8", name: "a"},
{type: "uint8", name: "b"},
])At first, it defines classes of structures by bre.defineObjectRecord or bre.defineArrayRecord.
The code above defines a class ExampleRecord which has 2 properties (a
and b).
ExampleRecord can be instantiated with an ArrayBuffer object or a view of
an ArrayBuffer object. E.g., Node.js Buffer objects are the view of
ArrayBuffer objects.
const buffer = Buffer.from([0x01, 0x02, 0x03])
const record1 = ExampleRecord.view(buffer, 0)
const record2 = ExampleRecord.view(buffer, 1) // offset 1ExampleRecord.view factory method creates an instance of ExampleRecord.
console.log(record1.a, record1.b) // => 1 2
console.log(record2.a, record2.b) // => 2 3
record1.b = 10
console.log(record1.b) // => 10
console.log(record2.a) // => 10
console.log(buffer[1]) // => 10Those record instances are just wrappers. The record1.a getter will read
the 1st byte of buffer directly. The record2.a getter will read the 2nd
byte of buffer directly.
Also, The record1.a setter will write the 1st byte of buffer directly.
This means that record2.a which is sharing the buffer will be changed.
This would be useful to read and write binary data.
Record classes have 2 properties to get the record size. Those are static getter properties (since records are fixed size).
const bytes = ExampleRecord.byteLength
const bits = ExampleRecord.bitLengthAlso, BinaryRecord class provides 2 methods to get the record size of a
record instance.
const bytes = bre.BinaryRecord.byteLength(record1)
const bits = bre.BinaryRecord.bitLength(record1)const bre = require("bre")Thank you for contributing!
Getting code:
$ git clone https://github.com/mysticatea/bre.git
$ cd bre
$ npm installTesting:
$ npm run watch