Fork of Restructure

Restructure allows you to declaratively encode and decode binary data. It supports a wide variety of types to enable you to express a multitude of binary formats without writing any parsing code.

Some of the supported features are C-like structures, versioned structures, pointers, arrays of any type, strings of a large number of encodings, enums, bitfields, and more. See the documentation below for more details.

Why fork?

Because on original repo is not possible release new version on npm see foliojs/restructure#45. This fork is same as original repo and is maintained up-to-date.

Installation

npm install @foliojs-fork/restructure

Example

This is just a small example of what Restructure can do. Check out the API documentation below for more information.

1var r = require('restructure');
2
3var Person = new r.Struct({
4  name: new r.String(r.uint8, 'utf8'),
5  age: r.uint8
6});
7
8// decode a person from a buffer
9var stream = new r.DecodeStream(buffer);
10Person.decode(stream); // returns an object with the fields defined above
11
12// encode a person from an object
13// pipe the stream to a destination, such as a file
14var stream = new r.EncodeStream();
15stream.pipe(fs.createWriteStream('out.bin'));
16
17Person.encode(stream, {
18  name: 'Devon',
19  age: 21
20});
21
22stream.end();

API

All of the following types support three standard methods:

• decode(stream) - decodes an instance of the type from the given DecodeStream
• size(value) - returns the amount of space the value would take if encoded
• encode(stream, value) - encodes the given value into the given EncodeStream

Restructure supports a wide variety of types, but if you need to write your own for some custom use that cannot be represented by them, you can do so by just implementing the above methods. Then you can use your type just as you would any other type, in structures and whatnot.

Number Types

The following built-in number types are available:

1uint8, uint16, uint24, uint32, int8, int16, int24, int32, float, double, fixed16, fixed32

Numbers are big-endian (network order) by default, but little-endian is supported, too:

1uint16le, uint24le, uint32le, int16le, int24le, int32le, floatle, doublele, fixed16le, fixed32le

To avoid ambiguity, big-endian may be used explicitly:

1uint16be, uint24be, uint32be, int16be, int24be, int32be, floatbe, doublebe, fixed16be, fixed32be

Boolean

Booleans are encoded as 0 or 1 using one of the above number types.

1var bool = new r.Boolean(r.uint32);

Reserved

The Reserved type simply skips data in a structure, where there are reserved fields. Encoding produces zeros.

1// 10 reserved uint8s (default is 1)
2var reserved = new r.Reserved(r.uint8, 10);

Optional

The Optional type only encodes or decodes when given condition is truthy.

1// includes field
2var optional = new r.Optional(r.uint8, true);
3
4// excludes field
5var optional = new r.Optional(r.uint8, false);
6
7// determine whether field is to be included at runtime with a function
8var optional = new r.Optional(r.uint8, function() {
9  return this.flags & 0x50;
10});

Enum

The Enum type maps a number to the value at that index in an array.

1var color = new r.Enum(r.uint8, ['red', 'orange', 'yellow', 'green', 'blue', 'purple']);

Bitfield

The Bitfield type maps a number to an object with boolean keys mapping to each bit in that number, as defined in an array.

1var bitfield = new r.Bitfield(r.uint8, ['Jack', 'Kack', 'Lack', 'Mack', 'Nack', 'Oack', 'Pack', 'Quack']);
2bitfield.decode(stream);
3
4var result = {
5  Jack: true,
6  Kack: false,
7  Lack: false,
8  Mack: true,
9  Nack: true,
10  Oack: false,
11  Pack: true,
12  Quack: true
13};
14
15bitfield.encode(stream, result);

Buffer

Extracts a slice of the buffer to a Node Buffer. The length can be a constant, or taken from a previous field in the parent structure.

1// fixed length
2var buf = new r.Buffer(2);
3
4// length from parent structure
5var struct = new r.Struct({
6  bufLen: r.uint8,
7  buf: new r.Buffer('bufLen')
8});

String

A String maps a JavaScript string to and from binary encodings. The length can be a constant, taken from a previous field in the parent structure, or encoded using a number type immediately before the string.

Supported encodings include 'ascii', 'utf8', 'ucs2', 'utf16le', 'utf16be', and if you also install iconv-lite, many other legacy codecs.

1// fixed length, ascii encoding by default
2var str = new r.String(2);
3
4// length encoded as number before the string, utf8 encoding
5var str = new r.String(r.uint8, 'utf8');
6
7// length from parent structure
8var struct = new r.Struct({
9  len: r.uint8,
10  str: new r.String('len', 'utf16be')
11});
12
13// null-terminated string (also known as C string)
14var str = new r.String(null, 'utf8')

Array

An Array maps to and from a JavaScript array containing instances of a sub-type. The length can be a constant, taken from a previous field in the parent structure, encoded using a number type immediately before the string, or computed by a function.

1// fixed length, containing numbers
2var arr = new r.Array(r.uint16, 2);
3
4// length encoded as number before the array containing strings
5var arr = new r.Array(new r.String(10), r.uint8);
6
7// length computed by a function
8var arr = new r.Array(r.uint8, function() { return 5 });
9
10// length from parent structure
11var struct = new r.Struct({
12  len: r.uint8,
13  arr: new r.Array(r.uint8, 'len')
14});
15
16// treat as amount of bytes instead (may be used in all the above scenarios)
17var arr = new r.Array(r.uint16, 6, 'bytes');

LazyArray

The LazyArray type extends from the Array type, and is useful for large arrays that you do not need to access sequentially. It avoids decoding the entire array upfront, and instead only decodes and caches individual items as needed. It only works when the elements inside the array have a fixed size.

Instead of returning a JavaScript array, the LazyArray type returns a custom object that can be used to access the elements.

1var arr = new r.LazyArray(r.uint16, 2048);
2var res = arr.decode(stream);
3
4// get a single element
5var el = res.get(2);
6
7// convert to a normal array (decode all elements)
8var array = res.toArray();

Struct

A Struct maps to and from JavaScript objects, containing keys of various previously discussed types. Sub structures, arrays of structures, and pointers to other types (discussed below) are supported.

1var Person = new r.Struct({
2  name: new r.String(r.uint8, 'utf8'),
3  age: r.uint8
4});

VersionedStruct

A VersionedStruct is a Struct that has multiple versions. The version is typically encoded at the beginning of the structure, or as a field in a parent structure. There is an optional header common to all versions, and separate fields listed for each version number.

1// the version is read as a uint8 in this example
2// you could also get the version from a key on the parent struct
3var Person = new r.VersionedStruct(r.uint8, {
4  // optional header common to all versions
5  header: {
6    name: new r.String(r.uint8, 'utf8')
7  },
8  0: {
9    age: r.uint8
10  },
11  1: {
12    hairColor: r.Enum(r.uint8, ['black', 'brown', 'blonde'])
13  }
14});

Pointer

Pointers map an address or offset encoded as a number, to a value encoded elsewhere in the buffer. There are a few options you can use: type, relativeTo, allowNull, and nullValue. The type option has these possible values:

• local (default) - the encoded offset is relative to the start of the containing structure
• immediate - the encoded offset is relative to the position of the pointer itself
• parent - the encoded offset is relative to the parent structure of the immediate container
• global - the encoded offset is global to the start of the file

The relativeTo option accepts a function callback that should return the field on the containing structure which the encoded offset is relative to. The callback is called with the context as parameter. By default, pointers are relative to the start of the containing structure (local).

The allowNull option lets you specify whether zero offsets are allowed or should produce null. This is set to true by default. The nullValue option is related, and lets you override the encoded value that represents null. By default, the nullValue is zero.

The lazy option allows lazy decoding of the pointer's value by defining a getter on the parent object. This only works when the pointer is contained within a Struct, but can be used to speed up decoding quite a bit when not all of the data is needed right away.

1var Address = new r.Struct({
2  street: new r.String(r.uint8),
3  zip: new r.String(5)
4});
5
6var Person = new r.Struct({
7  name: new r.String(r.uint8, 'utf8'),
8  age: r.uint8,
9  ptrStart: r.uint8,
10  address: new r.Pointer(r.uint8, Address)
11});

If the type of a pointer is set to 'void', it is not decoded and the computed address in the buffer is simply returned. To encode a void pointer, create a new r.VoidPointer(type, value).

License

MIT