jbuffers

A fork of module 'buffers', by Substack. Works with TypedArrays. Treat a collection of Buffers/TypedArrays as a single contiguous partially mutable Buffer.

npm install jbuffers
8 downloads in the last week
17 downloads in the last month

buffers

<<<<<<< HEAD

Treat a collection of Buffers as a single contiguous partially mutable Buffer or Typed Array.

Treat a collection of Buffers as a single contiguous partially mutable Buffer.

6cfde70ffc6b4121de4f1b48666aa043fb9bec3c

Where possible, operations execute without creating a new Buffer and copying everything over.

This is a cleaner more Buffery rehash of bufferlist.

<<<<<<< HEAD

example

with Typed Arrays (Int16Array, et al)

pass optional number specifying which kind of ArrayBuffer:

    var Buffers = require('buffers');
    var bufs = Buffers(6);
    bufs.push(new Float32Array([1,2,3]));

the number must correspond to the appropriate index in the following array:

var typedArrayTypes = [
    Int8Array,
    Int16Array,
    Int32Array,
    Uint8Array,
    Uint16Array,
    Uint32Array,
    Float32Array,
    Float64Array
]

======= build status

example

6cfde70ffc6b4121de4f1b48666aa043fb9bec3c

slice

var Buffers = require('buffers');
var bufs = Buffers();
bufs.push(new Buffer([1,2,3]));
bufs.push(new Buffer([4,5,6,7]));
bufs.push(new Buffer([8,9,10]));

console.dir(bufs.slice(2,8))

output:

$ node examples/slice.js 
<Buffer 03 04 05 06 07 08>

splice

var Buffers = require('buffers');
var bufs = Buffers([
    new Buffer([1,2,3]),
    new Buffer([4,5,6,7]),
    new Buffer([8,9,10]),
]);

var removed = bufs.splice(2, 4);
console.dir({
    removed : removed.slice(),
    bufs : bufs.slice(),
});

output:

$ node examples/splice.js
{ removed: <Buffer 03 04 05 06>,
  bufs: <Buffer 01 02 07 08 09 0a> }

methods

Buffers(buffers)

Create a Buffers with an array of Buffers if specified, else [].

.push(buf1, buf2...)

Push buffers onto the end. Just like Array.prototype.push.

.unshift(buf1, buf2...)

Unshift buffers onto the head. Just like Array.prototype.unshift.

.slice(i, j)

Slice a range out of the buffer collection as if it were contiguous. Works just like the Array.prototype.slice version.

.splice(i, howMany, replacements)

Splice the buffer collection as if it were contiguous. Works just like Array.prototype.splice, even the replacement part!

.copy(dst, dstStart, start, end)

Copy the buffer collection as if it were contiguous to the dst Buffer with the specified bounds. Works just like Buffer.prototype.copy.

.get(i)

Get a single element at index i.

.set(i, x)

Set a single element's value at index i.

.indexOf(needle, offset)

Find a string or buffer needle inside the buffer collection. Returns the position of the search string or -1 if the search string was not found.

Provide an offset to skip that number of characters at the beginning of the search. This can be used to find additional matches.

This function will return the correct result even if the search string is spread out over multiple internal buffers.

.toBuffer()

Convert the buffer collection to a single buffer, equivalent with .slice(0, buffers.length);

.toString(encoding, start, end)

Decodes and returns a string from the buffer collection. Works just like Buffer.prototype.toString

<<<<<<< HEAD

license

MIT/X11

6cfde70ffc6b4121de4f1b48666aa043fb9bec3c

npm loves you