diff options
author | James M Snell <jasnell@gmail.com> | 2016-03-23 14:27:39 -0700 |
---|---|---|
committer | James M Snell <jasnell@gmail.com> | 2016-04-08 20:16:46 -0700 |
commit | a2466896ddd0c89e80755a64acf0cac7e31e84e0 (patch) | |
tree | 0c2588c016e268d9199e62d2077d5e9393e44445 /doc | |
parent | 820844d6732a471ff0bff5ff477dec70133bdd3d (diff) | |
download | android-node-v8-a2466896ddd0c89e80755a64acf0cac7e31e84e0.tar.gz android-node-v8-a2466896ddd0c89e80755a64acf0cac7e31e84e0.tar.bz2 android-node-v8-a2466896ddd0c89e80755a64acf0cac7e31e84e0.zip |
buffer: add Buffer.prototype.compare by offset
Adds additional `targetStart`, `targetEnd`, `sourceStart,
and `sourceEnd` arguments to `Buffer.prototype.compare`
to allow comparison of sub-ranges of two Buffers without
requiring Buffer.prototype.slice()
Fixes: https://github.com/nodejs/node/issues/521
PR-URL: https://github.com/nodejs/node/pull/5880
Reviewed-By: Trevor Norris <trev.norris@gmail.com>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/api/buffer.markdown | 41 |
1 files changed, 34 insertions, 7 deletions
diff --git a/doc/api/buffer.markdown b/doc/api/buffer.markdown index f4f45c96cb..c1779b0d31 100644 --- a/doc/api/buffer.markdown +++ b/doc/api/buffer.markdown @@ -675,18 +675,26 @@ console.log(buf.toString('ascii')); // Prints: Node.js ``` -### buf.compare(otherBuffer) - -* `otherBuffer` {Buffer} +### buf.compare(target[, targetStart[, targetEnd[, sourceStart[, sourceEnd]]]]) + +* `target` {Buffer} +* `targetStart` {Integer} The offset within `target` at which to begin + comparison. default = `0`. +* `targetEnd` {Integer} The offset with `target` at which to end comparison. + Ignored when `targetStart` is `undefined`. default = `target.byteLength`. +* `sourceStart` {Integer} The offset within `buf` at which to begin comparison. + Ignored when `targetStart` is `undefined`. default = `0` +* `sourceEnd` {Integer} The offset within `buf` at which to end comparison. + Ignored when `targetStart` is `undefined`. default = `buf.byteLength`. * Return: {Number} Compares two Buffer instances and returns a number indicating whether `buf` -comes before, after, or is the same as the `otherBuffer` in sort order. +comes before, after, or is the same as the `target` in sort order. Comparison is based on the actual sequence of bytes in each Buffer. -* `0` is returned if `otherBuffer` is the same as `buf` -* `1` is returned if `otherBuffer` should come *before* `buf` when sorted. -* `-1` is returned if `otherBuffer` should come *after* `buf` when sorted. +* `0` is returned if `target` is the same as `buf` +* `1` is returned if `target` should come *before* `buf` when sorted. +* `-1` is returned if `target` should come *after* `buf` when sorted. ```js const buf1 = Buffer.from('ABC'); @@ -708,6 +716,25 @@ console.log(buf2.compare(buf3)); // produces sort order [buf1, buf3, buf2] ``` +The optional `targetStart`, `targetEnd`, `sourceStart`, and `sourceEnd` +arguments can be used to limit the comparison to specific ranges within the two +`Buffer` objects. + +```js +const buf1 = Buffer.from([1, 2, 3, 4, 5, 6, 7, 8, 9]); +const buf2 = Buffer.from([5, 6, 7, 8, 9, 1, 2, 3, 4]); + +console.log(buf1.compare(buf2, 5, 9, 0, 4)); + // Prints: 0 +console.log(buf1.compare(buf2, 0, 6, 4)); + // Prints: -1 +console.log(buf1.compare(buf2, 5, 6, 5)); + // Prints: 1 +``` + +A `RangeError` will be thrown if: `targetStart < 0`, `sourceStart < 0`, +`targetEnd > target.byteLength` or `sourceEnd > source.byteLength`. + ### buf.copy(targetBuffer[, targetStart[, sourceStart[, sourceEnd]]]) * `targetBuffer` {Buffer} Buffer to copy into |