Initial commit
This commit is contained in:
49
node_modules/cbor/vendor/binary-parse-stream/README.md
generated
vendored
Normal file
49
node_modules/cbor/vendor/binary-parse-stream/README.md
generated
vendored
Normal file
@@ -0,0 +1,49 @@
|
||||
# binary-parse-stream
|
||||
|
||||
Painless streaming binary protocol parsers using generators.
|
||||
|
||||
## Installation
|
||||
|
||||
npm install binary-parse-stream
|
||||
|
||||
## Synchronous
|
||||
|
||||
This module uses the exact same generator interface as [binary-parser](https://github.com/nathan7/binary-parser), which presents a synchronous interface to a generator parser.
|
||||
|
||||
## Usage
|
||||
|
||||
```javascript
|
||||
var BinaryParseStream = require('binary-parse-stream')
|
||||
, One = BinaryParseStream.One // -1
|
||||
```
|
||||
|
||||
BinaryParseStream is a TransformStream that consumes buffers and outputs objects on the other end.
|
||||
It expects your subclass to implement a `_parse` method that is a generator.
|
||||
When your generator yields a number, it'll be fed a buffer of that length from the input.
|
||||
If it yields -1, it'll be given the value of the first byte instead of a single-byte buffer.
|
||||
When your generator returns, the return value will be pushed to the output side.
|
||||
|
||||
## Example
|
||||
|
||||
The following module parses a protocol that consists of a 32-bit unsigned big-endian type parameter, an unsigned 8-bit length parameter, and a buffer of the specified length.
|
||||
It outputs `{type, buf}` objects.
|
||||
|
||||
```js
|
||||
var BinaryParseStream = require('binary-parse-stream')
|
||||
, inherits = require('util').inherits
|
||||
|
||||
module.exports = SillyProtocolParseStream
|
||||
inherits(SillyProtocolParseStream, BinaryParseStream)
|
||||
function SillyProtocolParseStream(options) {
|
||||
BinaryParseStream.call(this, options)
|
||||
}
|
||||
SillyProtocolParseStream.prototype._parse = function*() {
|
||||
var type = (yield 4).readUInt32BE(0, true)
|
||||
, length = yield -1
|
||||
, buf = yield length
|
||||
return { type: type, buf: buf }
|
||||
}
|
||||
```
|
||||
|
||||
There is also a shorter syntax for when you don't want to explicitly subclass: `BinaryParseStream.extend(function*())`.
|
||||
|
||||
84
node_modules/cbor/vendor/binary-parse-stream/index.js
generated
vendored
Normal file
84
node_modules/cbor/vendor/binary-parse-stream/index.js
generated
vendored
Normal file
@@ -0,0 +1,84 @@
|
||||
// Tweaked version of nathan7's binary-parse-stream
|
||||
// (see https://github.com/nathan7/binary-parse-stream)
|
||||
// Uses NoFilter instead of the readable in the original. Removes
|
||||
// the ability to read -1, which was odd and un-needed.
|
||||
// License for binary-parse-stream: MIT
|
||||
|
||||
// binary-parse-stream is now unmaintained, so I'm going to rewrite it as
|
||||
// more modern JS so I can get tsc to help check types.
|
||||
|
||||
'use strict'
|
||||
const Stream = require('stream')
|
||||
const NoFilter = require('nofilter')
|
||||
const TransformStream = Stream.Transform
|
||||
|
||||
/**
|
||||
* BinaryParseStream is a TransformStream that consumes buffers and outputs
|
||||
* objects on the other end. It expects your subclass to implement a `_parse`
|
||||
* method that is a generator. When your generator yields a number, it'll be
|
||||
* fed a buffer of that length from the input. When your generator returns,
|
||||
* the return value will be pushed to the output side.
|
||||
*
|
||||
* @class BinaryParseStream
|
||||
* @extends {TransformStream}
|
||||
*/
|
||||
class BinaryParseStream extends TransformStream {
|
||||
constructor(options) {
|
||||
super(options)
|
||||
// doesn't work to pass these in as opts, for some reason
|
||||
this['_writableState'].objectMode = false
|
||||
this['_readableState'].objectMode = true
|
||||
|
||||
this.bs = new NoFilter()
|
||||
this.__restart()
|
||||
}
|
||||
|
||||
_transform(fresh, encoding, cb) {
|
||||
this.bs.write(fresh)
|
||||
|
||||
while (this.bs.length >= this.__needed) {
|
||||
let ret
|
||||
const chunk = (this.__needed === null) ?
|
||||
undefined : this.bs.read(this.__needed)
|
||||
|
||||
try {
|
||||
ret = this.__parser.next(chunk)
|
||||
} catch (e) {
|
||||
return cb(e)
|
||||
}
|
||||
|
||||
if (this.__needed) {
|
||||
this.__fresh = false
|
||||
}
|
||||
|
||||
if (!ret.done) {
|
||||
this.__needed = ret.value || 0
|
||||
} else {
|
||||
this.push(ret.value)
|
||||
this.__restart()
|
||||
}
|
||||
}
|
||||
|
||||
return cb()
|
||||
}
|
||||
|
||||
/**
|
||||
* @abstract
|
||||
*/
|
||||
/* istanbul ignore next */
|
||||
*_parse() {
|
||||
throw new Error('Must be implemented in subclass')
|
||||
}
|
||||
|
||||
__restart() {
|
||||
this.__needed = null
|
||||
this.__parser = this._parse()
|
||||
this.__fresh = true
|
||||
}
|
||||
|
||||
_flush(cb) {
|
||||
cb(this.__fresh ? null : new Error('unexpected end of input'))
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = BinaryParseStream
|
||||
Reference in New Issue
Block a user