FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

buffer: make methods work on Uint8Array instances · nodejs/node@92c517c · GitHub

/ node Public

Commit 92c517c

Browse files
nbbeeken
authored and
aduh95
committed
buffer: make methods work on Uint8Array instances
Removes the reliance on prototype bound methods internally so that Uint8Arrays can be set as the bound `this` value when calling the various Buffer methods. Introduces some additional tamper protection by removing internal reliance on writable properties. Fixes: #56577 PR-URL: #56578 Reviewed-By: Anna Henningsen <anna@addaleax.net>
1 parent ea46879 commit 92c517c

8 files changed

Lines changed: 1337 additions & 156 deletions

File tree

‎doc/api/buffer.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -415,6 +415,21 @@ function:
415415
* [`Buffer.from(arrayBuffer[, byteOffset[, length]])`][`Buffer.from(arrayBuf)`]
416416
* [`Buffer.from(string[, encoding])`][`Buffer.from(string)`]
417417

418+
### Buffer methods are callable with `Uint8Array` instances
419+
420+
All methods on the Buffer prototype are callable with a `Uint8Array` instance.
421+
422+
```js
423+
const { toString, write } = Buffer.prototype;
424+
425+
const uint8array = new Uint8Array(5);
426+
427+
write.call(uint8array, 'hello', 0, 5, 'utf8'); // 5
428+
// <Uint8Array 68 65 6c 6c 6f>
429+
430+
toString.call(uint8array, 'utf8'); // 'hello'
431+
```
432+
418433
## Buffers and iteration
419434

420435
`Buffer` instances can be iterated over using `for..of` syntax:
@@ -2058,6 +2073,10 @@ console.log(buf.fill('zz', 'hex'));
20582073

20592074
<!-- YAML
20602075
added: v5.3.0
2076+
changes:
2077+
- version: REPLACEME
2078+
pr-url: https://github.com/nodejs/node/pull/56578
2079+
description: supports Uint8Array as `this` value.
20612080
-->
20622081

20632082
* `value` {string|Buffer|Uint8Array|integer} What to search for.
@@ -2945,10 +2964,14 @@ console.log(buf.readInt32LE(1));
29452964
<!-- YAML
29462965
added: v0.11.15
29472966
changes:
2967+
- version: REPLACEME
2968+
pr-url: https://github.com/nodejs/node/pull/56578
2969+
description: supports Uint8Array as `this` value.
29482970
- version: v10.0.0
29492971
pr-url: https://github.com/nodejs/node/pull/18395
29502972
description: Removed `noAssert` and no implicit coercion of the offset
29512973
and `byteLength` to `uint32` anymore.
2974+
29522975
-->
29532976

29542977
* `offset` {integer} Number of bytes to skip before starting to read. Must
@@ -2992,10 +3015,14 @@ console.log(buf.readIntBE(1, 0).toString(16));
29923015
<!-- YAML
29933016
added: v0.11.15
29943017
changes:
3018+
- version: REPLACEME
3019+
pr-url: https://github.com/nodejs/node/pull/56578
3020+
description: supports Uint8Array as `this` value.
29953021
- version: v10.0.0
29963022
pr-url: https://github.com/nodejs/node/pull/18395
29973023
description: Removed `noAssert` and no implicit coercion of the offset
29983024
and `byteLength` to `uint32` anymore.
3025+
29993026
-->
30003027

30013028
* `offset` {integer} Number of bytes to skip before starting to read. Must
@@ -3269,6 +3296,9 @@ console.log(buf.readUInt32LE(1).toString(16));
32693296
<!-- YAML
32703297
added: v0.11.15
32713298
changes:
3299+
- version: REPLACEME
3300+
pr-url: https://github.com/nodejs/node/pull/56578
3301+
description: supports Uint8Array as `this` value.
32723302
- version:
32733303
- v14.9.0
32743304
- v12.19.0
@@ -3319,6 +3349,9 @@ console.log(buf.readUIntBE(1, 6).toString(16));
33193349
<!-- YAML
33203350
added: v0.11.15
33213351
changes:
3352+
- version: REPLACEME
3353+
pr-url: https://github.com/nodejs/node/pull/56578
3354+
description: supports Uint8Array as `this` value.
33223355
- version:
33233356
- v14.9.0
33243357
- v12.19.0
@@ -3771,6 +3804,10 @@ console.log(copy);
37713804

37723805
<!-- YAML
37733806
added: v0.1.90
3807+
changes:
3808+
- version: REPLACEME
3809+
pr-url: https://github.com/nodejs/node/pull/56578
3810+
description: supports Uint8Array as `this` value.
37743811
-->
37753812

37763813
* `encoding` {string} The character encoding to use. **Default:** `'utf8'`.
@@ -3909,6 +3946,10 @@ for (const value of buf) {
39093946

39103947
<!-- YAML
39113948
added: v0.1.90
3949+
changes:
3950+
- version: REPLACEME
3951+
pr-url: https://github.com/nodejs/node/pull/56578
3952+
description: supports Uint8Array as `this` value.
39123953
-->
39133954

39143955
* `string` {string} String to write to `buf`.

‎lib/buffer.js‎

Lines changed: 37 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,17 @@ const {
7373
kStringMaxLength,
7474
atob: _atob,
7575
btoa: _btoa,
76+
asciiSlice,
77+
base64Slice,
78+
base64urlSlice,
79+
latin1Slice,
80+
hexSlice,
81+
ucs2Slice,
82+
utf8Slice,
83+
base64Write,
84+
base64urlWrite,
85+
hexWrite,
86+
ucs2Write,
7687
} = internalBinding('buffer');
7788
const {
7889
constants: {
@@ -129,6 +140,9 @@ const {
129140
markAsUntransferable,
130141
addBufferPrototypeMethods,
131142
createUnsafeBuffer,
143+
asciiWrite,
144+
latin1Write,
145+
utf8Write,
132146
} = require('internal/buffer');
133147

134148
FastBuffer.prototype.constructor = Buffer;
@@ -646,44 +660,44 @@ const encodingOps = {
646660
encoding: 'utf8',
647661
encodingVal: encodingsMap.utf8,
648662
byteLength: byteLengthUtf8,
649-
write: (buf, string, offset, len) => buf.utf8Write(string, offset, len),
650-
slice: (buf, start, end) => buf.utf8Slice(start, end),
663+
write: utf8Write,
664+
slice: utf8Slice,
651665
indexOf: (buf, val, byteOffset, dir) =>
652666
indexOfString(buf, val, byteOffset, encodingsMap.utf8, dir),
653667
},
654668
ucs2: {
655669
encoding: 'ucs2',
656670
encodingVal: encodingsMap.utf16le,
657671
byteLength: (string) => string.length * 2,
658-
write: (buf, string, offset, len) => buf.ucs2Write(string, offset, len),
659-
slice: (buf, start, end) => buf.ucs2Slice(start, end),
672+
write: ucs2Write,
673+
slice: ucs2Slice,
660674
indexOf: (buf, val, byteOffset, dir) =>
661675
indexOfString(buf, val, byteOffset, encodingsMap.utf16le, dir),
662676
},
663677
utf16le: {
664678
encoding: 'utf16le',
665679
encodingVal: encodingsMap.utf16le,
666680
byteLength: (string) => string.length * 2,
667-
write: (buf, string, offset, len) => buf.ucs2Write(string, offset, len),
668-
slice: (buf, start, end) => buf.ucs2Slice(start, end),
681+
write: ucs2Write,
682+
slice: ucs2Slice,
669683
indexOf: (buf, val, byteOffset, dir) =>
670684
indexOfString(buf, val, byteOffset, encodingsMap.utf16le, dir),
671685
},
672686
latin1: {
673687
encoding: 'latin1',
674688
encodingVal: encodingsMap.latin1,
675689
byteLength: (string) => string.length,
676-
write: (buf, string, offset, len) => buf.latin1Write(string, offset, len),
677-
slice: (buf, start, end) => buf.latin1Slice(start, end),
690+
write: latin1Write,
691+
slice: latin1Slice,
678692
indexOf: (buf, val, byteOffset, dir) =>
679693
indexOfString(buf, val, byteOffset, encodingsMap.latin1, dir),
680694
},
681695
ascii: {
682696
encoding: 'ascii',
683697
encodingVal: encodingsMap.ascii,
684698
byteLength: (string) => string.length,
685-
write: (buf, string, offset, len) => buf.asciiWrite(string, offset, len),
686-
slice: (buf, start, end) => buf.asciiSlice(start, end),
699+
write: asciiWrite,
700+
slice: asciiSlice,
687701
indexOf: (buf, val, byteOffset, dir) =>
688702
indexOfBuffer(buf,
689703
fromStringFast(val, encodingOps.ascii),
@@ -695,8 +709,8 @@ const encodingOps = {
695709
encoding: 'base64',
696710
encodingVal: encodingsMap.base64,
697711
byteLength: (string) => base64ByteLength(string, string.length),
698-
write: (buf, string, offset, len) => buf.base64Write(string, offset, len),
699-
slice: (buf, start, end) => buf.base64Slice(start, end),
712+
write: base64Write,
713+
slice: base64Slice,
700714
indexOf: (buf, val, byteOffset, dir) =>
701715
indexOfBuffer(buf,
702716
fromStringFast(val, encodingOps.base64),
@@ -708,9 +722,8 @@ const encodingOps = {
708722
encoding: 'base64url',
709723
encodingVal: encodingsMap.base64url,
710724
byteLength: (string) => base64ByteLength(string, string.length),
711-
write: (buf, string, offset, len) =>
712-
buf.base64urlWrite(string, offset, len),
713-
slice: (buf, start, end) => buf.base64urlSlice(start, end),
725+
write: base64urlWrite,
726+
slice: base64urlSlice,
714727
indexOf: (buf, val, byteOffset, dir) =>
715728
indexOfBuffer(buf,
716729
fromStringFast(val, encodingOps.base64url),
@@ -722,8 +735,8 @@ const encodingOps = {
722735
encoding: 'hex',
723736
encodingVal: encodingsMap.hex,
724737
byteLength: (string) => string.length >>> 1,
725-
write: (buf, string, offset, len) => buf.hexWrite(string, offset, len),
726-
slice: (buf, start, end) => buf.hexSlice(start, end),
738+
write: hexWrite,
739+
slice: hexSlice,
727740
indexOf: (buf, val, byteOffset, dir) =>
728741
indexOfBuffer(buf,
729742
fromStringFast(val, encodingOps.hex),
@@ -848,7 +861,7 @@ Buffer.prototype.copy =
848861
// to their upper/lower bounds if the value passed is out of range.
849862
Buffer.prototype.toString = function toString(encoding, start, end) {
850863
if (arguments.length === 0) {
851-
return this.utf8Slice(0, this.length);
864+
return utf8Slice(this, 0, this.length);
852865
}
853866

854867
const len = this.length;
@@ -869,7 +882,7 @@ Buffer.prototype.toString = function toString(encoding, start, end) {
869882
return '';
870883

871884
if (encoding === undefined)
872-
return this.utf8Slice(start, end);
885+
return utf8Slice(this, start, end);
873886

874887
const ops = getEncodingOps(encoding);
875888
if (ops === undefined)
@@ -900,7 +913,7 @@ Buffer.prototype[customInspectSymbol] = function inspect(recurseTimes, ctx) {
900913
const actualMax = MathMin(max, this.length);
901914
const remaining = this.length - max;
902915
let str = StringPrototypeTrim(RegExpPrototypeSymbolReplace(
903-
/(.{2})/g, this.hexSlice(0, actualMax), '$1 '));
916+
/(.{2})/g, hexSlice(this, 0, actualMax), '$1 '));
904917
if (remaining > 0)
905918
str += ` ... ${remaining} more byte${remaining > 1 ? 's' : ''}`;
906919
// Inspect special properties as well, if possible.
@@ -1039,7 +1052,7 @@ Buffer.prototype.lastIndexOf = function lastIndexOf(val, byteOffset, encoding) {
10391052
};
10401053

10411054
Buffer.prototype.includes = function includes(val, byteOffset, encoding) {
1042-
return this.indexOf(val, byteOffset, encoding) !== -1;
1055+
return bidirectionalIndexOf(this, val, byteOffset, encoding, true) !== -1;
10431056
};
10441057

10451058
// Usage:
@@ -1124,7 +1137,7 @@ function _fill(buf, value, offset, end, encoding) {
11241137
Buffer.prototype.write = function write(string, offset, length, encoding) {
11251138
// Buffer#write(string);
11261139
if (offset === undefined) {
1127-
return this.utf8Write(string, 0, this.length);
1140+
return utf8Write(this, string, 0, this.length);
11281141
}
11291142
// Buffer#write(string, encoding)
11301143
if (length === undefined && typeof offset === 'string') {
@@ -1151,9 +1164,9 @@ Buffer.prototype.write = function write(string, offset, length, encoding) {
11511164
}
11521165

11531166
if (!encoding || encoding === 'utf8')
1154-
return this.utf8Write(string, offset, length);
1167+
return utf8Write(this, string, offset, length);
11551168
if (encoding === 'ascii')
1156-
return this.asciiWrite(string, offset, length);
1169+
return asciiWrite(this, string, offset, length);
11571170

11581171
const ops = getEncodingOps(encoding);
11591172
if (ops === undefined)

0 commit comments

Comments
 (0)
Back | FazBrowse Home | New Git URL