@nuintun/buffer 0.3.0 → 0.3.2

package/cjs/Binary.cjs

@@ -1,7 +1,7 @@
 /**
  * @package @nuintun/buffer
  * @license MIT
- * @version 0.3.0
+ * @version 0.3.2
  * @author nuintun <nuintun@qq.com>
  * @description A buffer tool for javascript.
  * @see https://github.com/nuintun/Buffer#readme

package/cjs/Encoding/UTF8.cjs

@@ -1,7 +1,7 @@
 /**
  * @package @nuintun/buffer
  * @license MIT
- * @version 0.3.0
+ * @version 0.3.2
  * @author nuintun <nuintun@qq.com>
  * @description A buffer tool for javascript.
  * @see https://github.com/nuintun/Buffer#readme

package/cjs/Encoding/Unicode.cjs

@@ -1,7 +1,7 @@
 /**
  * @package @nuintun/buffer
  * @license MIT
- * @version 0.3.0
+ * @version 0.3.2
  * @author nuintun <nuintun@qq.com>
  * @description A buffer tool for javascript.
  * @see https://github.com/nuintun/Buffer#readme

package/cjs/Encoding/index.cjs

@@ -1,7 +1,7 @@
 /**
  * @package @nuintun/buffer
  * @license MIT
- * @version 0.3.0
+ * @version 0.3.2
  * @author nuintun <nuintun@qq.com>
  * @description A buffer tool for javascript.
  * @see https://github.com/nuintun/Buffer#readme

package/cjs/enum.cjs

@@ -0,0 +1,20 @@
+/**
+ * @package @nuintun/buffer
+ * @license MIT
+ * @version 0.3.2
+ * @author nuintun <nuintun@qq.com>
+ * @description A buffer tool for javascript.
+ * @see https://github.com/nuintun/Buffer#readme
+ */
+
+'use strict';
+
+/**
+ * @module enum
+ */
+// 字节序类型
+exports.Endian = void 0;
+(function (Endian) {
+  Endian[(Endian['Big'] = 0)] = 'Big';
+  Endian[(Endian['Little'] = 1)] = 'Little';
+})(exports.Endian || (exports.Endian = {}));

package/cjs/enum.d.cts

@@ -1,6 +1,10 @@
 /**
  * @module enum
  */
+export declare enum Endian {
+  Big = 0,
+  Little = 1
+}
 export declare const enum SizeOf {
   INT8 = 1,
   UINT8 = 1,

package/cjs/errors.cjs

@@ -1,7 +1,7 @@
 /**
  * @package @nuintun/buffer
  * @license MIT
- * @version 0.3.0
+ * @version 0.3.2
  * @author nuintun <nuintun@qq.com>
  * @description A buffer tool for javascript.
  * @see https://github.com/nuintun/Buffer#readme
@@ -12,24 +12,28 @@
 /**
  * @module errors
  */
-// 未支持的编码格式
+/**
+ * @function encodingInvalid
+ * @description 未支持的编码格式
+ * @param encoding 编码格式
+ */
 function encodingInvalid(encoding) {
   return 'unsupported encoding ' + encoding;
 }
-// 未知字节序
-const unknownEndianness = 'unknown endianness';
-// 非法长度
-const lengthInvalid = 'invalid buffer length';
 // 非法读写指针
 const offsetInvalid = 'invalid buffer offset';
+// 非法长度
+const lengthInvalid = 'invalid buffer length';
+// 未知字节序
+const unknownEndianness = 'unknown endianness';
+// 数据读取长度非法
+const readLengthInvalid = 'invalid read length';
 // 数据读取溢出
 const readOverflow = 'read is outside the bounds of the Buffer';
-// 读写指针溢出
-const offsetOverflow = 'offset is outside the bounds of the Buffer';
 
 exports.encodingInvalid = encodingInvalid;
 exports.lengthInvalid = lengthInvalid;
 exports.offsetInvalid = offsetInvalid;
-exports.offsetOverflow = offsetOverflow;
+exports.readLengthInvalid = readLengthInvalid;
 exports.readOverflow = readOverflow;
 exports.unknownEndianness = unknownEndianness;

package/cjs/errors.d.cts

@@ -1,9 +1,15 @@
 /**
  * @module errors
  */
+/**
+ * @function encodingInvalid
+ * @description 未支持的编码格式
+ * @param encoding 编码格式
+ */
 export declare function encodingInvalid(encoding: string): string;
-export declare const unknownEndianness = 'unknown endianness';
-export declare const lengthInvalid = 'invalid buffer length';
 export declare const offsetInvalid = 'invalid buffer offset';
+export declare const lengthInvalid = 'invalid buffer length';
+export declare const unknownEndianness = 'unknown endianness';
+export declare const readLengthInvalid = 'invalid read length';
 export declare const readOverflow = 'read is outside the bounds of the Buffer';
 export declare const offsetOverflow = 'offset is outside the bounds of the Buffer';

package/cjs/index.cjs

@@ -1,7 +1,7 @@
 /**
  * @package @nuintun/buffer
  * @license MIT
- * @version 0.3.0
+ * @version 0.3.2
  * @author nuintun <nuintun@qq.com>
  * @description A buffer tool for javascript.
  * @see https://github.com/nuintun/Buffer#readme
@@ -9,31 +9,26 @@
 
 'use strict';
 
-const utils = require('./utils.cjs');
 const Binary = require('./Binary.cjs');
 const errors = require('./errors.cjs');
 const index = require('./Encoding/index.cjs');
+const _enum = require('./enum.cjs');
+const utils = require('./utils.cjs');
 
 /**
  * @module Buffer
  */
-// 字节序类型
-exports.Endian = void 0;
-(function (Endian) {
-  Endian[(Endian['Big'] = 0)] = 'Big';
-  Endian[(Endian['Little'] = 1)] = 'Little';
-})(exports.Endian || (exports.Endian = {}));
 /**
  * @function endianness
  * @description 获取系统默认字节序
  * @returns {Endian}
  */
 function endianness() {
-  switch (new Uint8Array(new Uint32Array([0x12345678]))[0]) {
-    case 0x12:
-      return exports.Endian.Big;
-    case 0x78:
-      return exports.Endian.Little;
+  switch (new Uint8Array(new Uint16Array([0x00ff]).buffer)[0]) {
+    case 0x00:
+      return _enum.Endian.Big;
+    case 0xff:
+      return _enum.Endian.Little;
     default:
       throw new TypeError(errors.unknownEndianness);
   }
@@ -54,45 +49,64 @@ class Buffer {
   #offset = 0;
   // 已使用字节长度
   #length = 0;
+  /**
+   * @constructor
+   * @param {number | Uint8Array | ArrayBuffer} [input] 缓冲区初始配置
+   * @param {number} [pageSize] 缓冲区分页大小，扩容时将按分页大小增加
+   */
   constructor(input = 0, pageSize = 4096) {
-    this.#pageSize = pageSize;
-    if (input instanceof Uint8Array) {
-      this.#bytes = input;
-      this.#length = input.length;
-      this.#dataView = new DataView(input.buffer);
+    let length;
+    let bytes;
+    if (utils.isTypedArray(input)) {
+      length = input.byteLength;
+      bytes = utils.makeUint8Array(length, pageSize);
+      if (length > 0) {
+        bytes.set(new Uint8Array(input.buffer));
+      }
+    } else if (input instanceof ArrayBuffer) {
+      length = input.byteLength;
+      bytes = utils.makeUint8Array(length, pageSize);
+      if (length > 0) {
+        bytes.set(new Uint8Array(input));
+      }
     } else {
-      const bytes = utils.makeUint8Array(input, pageSize);
-      this.#bytes = bytes;
-      this.#length = input;
-      this.#dataView = new DataView(bytes.buffer);
+      length = input;
+      bytes = utils.makeUint8Array(length, pageSize);
     }
+    this.#bytes = bytes;
+    this.#length = length;
+    this.#pageSize = pageSize;
+    this.#dataView = new DataView(bytes.buffer);
   }
   /**
    * @private
-   * @method grow
-   * @description 增加长度
-   * @param {number} length 长度增加量
+   * @method seek
+   * @description 移动读写指针
+   * @param {number} offset 指针位置
    */
-  #grow(length) {
-    this.#length += length;
+  #seek(offset) {
+    if (offset > this.#length) {
+      this.#length = offset;
+    }
+    this.#offset = offset;
   }
   /**
    * @private
-   * @method seek
-   * @description 移动读写指针
-   * @param {number} offset 指针偏移量
+   * @method getOffset
+   * @description 根据数据类型获取最新指针位置
+   * @param size 数据类型长度
    */
-  #seek(offset) {
-    this.#offset += offset;
+  #getOffset(size) {
+    return this.#offset + size;
   }
   /**
    * @private
    * @method assertRead
    * @description 读取断言，防止越界读取
-   * @param {number} length 断言字节长度
+   * @param {number} size 断言字节长度
    */
   #assertRead(length) {
-    if (length < 0 || this.#offset + length > this.#length) {
+    if (length > this.#length) {
       throw new RangeError(errors.readOverflow);
     }
   }
@@ -103,7 +117,6 @@ class Buffer {
    * @param {number} length 分配字节长度
    */
   #alloc(length) {
-    length += this.#offset;
     const bytes = this.#bytes;
     if (length > bytes.length) {
       const newBytes = utils.makeUint8Array(length, this.#pageSize);
@@ -119,12 +132,9 @@ class Buffer {
    * @description 下一次调用读写方法时将在此位置开始读写
    */
   set offset(offset) {
-    if (offset < 0) {
+    if (!utils.isNaturalNumber(offset)) {
       throw new RangeError(errors.offsetInvalid);
     }
-    if (offset > this.#length) {
-      throw new RangeError(errors.offsetOverflow);
-    }
     this.#offset = offset;
   }
   /**
@@ -144,7 +154,7 @@ class Buffer {
    * @description 如果将长度设置为大于当前长度的值，则用零填充字节数组的右侧
    */
   set length(length) {
-    if (length < 0) {
+    if (!utils.isNaturalNumber(length)) {
       throw new RangeError(errors.lengthInvalid);
     }
     const currentLength = this.#length;
@@ -171,16 +181,16 @@ class Buffer {
   /**
    * @public
    * @property {ArrayBuffer} buffer
-   * @description 获取 ArrayBuffer 缓冲区
+   * @description 获取全部 ArrayBuffer 原始缓冲区
    * @returns {ArrayBuffer}
    */
   get buffer() {
-    return this.bytes.buffer;
+    return this.#bytes.buffer;
   }
   /**
    * @public
    * @property {Uint8Array} bytes
-   * @description 获取 Uint8Array 缓冲区
+   * @description 获取已写入 Uint8Array 原始缓冲区
    * @returns {Uint8Array}
    */
   get bytes() {
@@ -193,10 +203,10 @@ class Buffer {
    * @param {number} value 介于 -128 和 127 之间的整数
    */
   writeInt8(value) {
-    this.#alloc(1 /* SizeOf.INT8 */);
+    const offset = this.#getOffset(1 /* SizeOf.INT8 */);
+    this.#alloc(offset);
     this.#dataView.setInt8(this.#offset, value);
-    this.#grow(1 /* SizeOf.INT8 */);
-    this.#seek(1 /* SizeOf.INT8 */);
+    this.#seek(offset);
   }
   /**
    * @public
@@ -205,10 +215,10 @@ class Buffer {
    * @param {number} value 介于 0 和 255 之间的整数
    */
   writeUint8(value) {
-    this.#alloc(1 /* SizeOf.UINT8 */);
+    const offset = this.#getOffset(1 /* SizeOf.UINT8 */);
+    this.#alloc(offset);
     this.#dataView.setUint8(this.#offset, value);
-    this.#grow(1 /* SizeOf.UINT8 */);
-    this.#seek(1 /* SizeOf.UINT8 */);
+    this.#seek(offset);
   }
   /**
    * @method writeBoolean
@@ -225,10 +235,10 @@ class Buffer {
    * @param {boolean} [littleEndian] 是否为小端字节序
    */
   writeInt16(value, littleEndian) {
-    this.#alloc(2 /* SizeOf.INT16 */);
+    const offset = this.#getOffset(2 /* SizeOf.INT16 */);
+    this.#alloc(offset);
     this.#dataView.setInt16(this.#offset, value, littleEndian);
-    this.#grow(2 /* SizeOf.INT16 */);
-    this.#seek(2 /* SizeOf.INT16 */);
+    this.#seek(offset);
   }
   /**
    * @method writeUint16
@@ -237,10 +247,10 @@ class Buffer {
    * @param {boolean} [littleEndian] 是否为小端字节序
    */
   writeUint16(value, littleEndian) {
-    this.#alloc(2 /* SizeOf.UINT16 */);
+    const offset = this.#getOffset(2 /* SizeOf.UINT16 */);
+    this.#alloc(offset);
     this.#dataView.setUint16(this.#offset, value, littleEndian);
-    this.#grow(2 /* SizeOf.UINT16 */);
-    this.#seek(2 /* SizeOf.UINT16 */);
+    this.#seek(offset);
   }
   /**
    * @method writeInt32
@@ -249,10 +259,10 @@ class Buffer {
    * @param {boolean} [littleEndian] 是否为小端字节序
    */
   writeInt32(value, littleEndian) {
-    this.#alloc(4 /* SizeOf.INT32 */);
+    const offset = this.#getOffset(4 /* SizeOf.INT32 */);
+    this.#alloc(offset);
     this.#dataView.setInt32(this.#offset, value, littleEndian);
-    this.#grow(4 /* SizeOf.INT32 */);
-    this.#seek(4 /* SizeOf.INT32 */);
+    this.#seek(offset);
   }
   /**
    * @method writeUint32
@@ -261,10 +271,10 @@ class Buffer {
    * @param {boolean} [littleEndian] 是否为小端字节序
    */
   writeUint32(value, littleEndian) {
-    this.#alloc(4 /* SizeOf.UINT32 */);
+    const offset = this.#getOffset(4 /* SizeOf.UINT32 */);
+    this.#alloc(offset);
     this.#dataView.setUint32(this.#offset, value, littleEndian);
-    this.#grow(4 /* SizeOf.UINT32 */);
-    this.#seek(4 /* SizeOf.UINT32 */);
+    this.#seek(offset);
   }
   /**
    * @method writeInt64
@@ -273,10 +283,10 @@ class Buffer {
    * @param {boolean} [littleEndian] 是否为小端字节序
    */
   writeInt64(value, littleEndian) {
-    this.#alloc(8 /* SizeOf.INT64 */);
+    const offset = this.#getOffset(8 /* SizeOf.INT64 */);
+    this.#alloc(offset);
     this.#dataView.setBigInt64(this.#offset, value, littleEndian);
-    this.#grow(8 /* SizeOf.INT64 */);
-    this.#seek(8 /* SizeOf.INT64 */);
+    this.#seek(offset);
   }
   /**
    * @method writeUint64
@@ -285,10 +295,10 @@ class Buffer {
    * @param {boolean} [littleEndian] 是否为小端字节序
    */
   writeUint64(value, littleEndian) {
-    this.#alloc(8 /* SizeOf.UINT64 */);
+    const offset = this.#getOffset(8 /* SizeOf.UINT64 */);
+    this.#alloc(offset);
     this.#dataView.setBigUint64(this.#offset, value, littleEndian);
-    this.#grow(8 /* SizeOf.UINT64 */);
-    this.#seek(8 /* SizeOf.UINT64 */);
+    this.#seek(offset);
   }
   /**
    * @method writeFloat32
@@ -297,10 +307,10 @@ class Buffer {
    * @param {boolean} [littleEndian] 是否为小端字节序
    */
   writeFloat32(value, littleEndian) {
-    this.#alloc(4 /* SizeOf.FLOAT32 */);
+    const offset = this.#getOffset(4 /* SizeOf.FLOAT32 */);
+    this.#alloc(offset);
     this.#dataView.setFloat32(this.#offset, value, littleEndian);
-    this.#grow(4 /* SizeOf.FLOAT32 */);
-    this.#seek(4 /* SizeOf.FLOAT32 */);
+    this.#seek(offset);
   }
   /**
    * @method writeFloat64
@@ -309,10 +319,10 @@ class Buffer {
    * @param {boolean} [littleEndian] 是否为小端字节序
    */
   writeFloat64(value, littleEndian) {
-    this.#alloc(8 /* SizeOf.FLOAT64 */);
+    const offset = this.#getOffset(8 /* SizeOf.FLOAT64 */);
+    this.#alloc(offset);
     this.#dataView.setFloat64(this.#offset, value, littleEndian);
-    this.#grow(8 /* SizeOf.FLOAT64 */);
-    this.#seek(8 /* SizeOf.FLOAT64 */);
+    this.#seek(offset);
   }
   write(input, start, end) {
     let bytes;
@@ -323,10 +333,10 @@ class Buffer {
     }
     const { length } = bytes;
     if (length > 0) {
-      this.#alloc(length);
+      const offset = this.#getOffset(length);
+      this.#alloc(offset);
       this.#bytes.set(bytes, this.#offset);
-      this.#grow(length);
-      this.#seek(length);
+      this.#seek(offset);
     }
   }
   /**
@@ -335,9 +345,10 @@ class Buffer {
    * @returns {number} 介于 -128 和 127 之间的整数
    */
   readInt8() {
-    this.#assertRead(1 /* SizeOf.INT8 */);
+    const offset = this.#getOffset(1 /* SizeOf.INT8 */);
+    this.#assertRead(offset);
     const value = this.#dataView.getInt8(this.#offset);
-    this.#seek(1 /* SizeOf.INT8 */);
+    this.#seek(offset);
     return value;
   }
   /**
@@ -346,9 +357,10 @@ class Buffer {
    * @returns {number} 介于 0 和 255 之间的无符号整数
    */
   readUint8() {
-    this.#assertRead(1 /* SizeOf.UINT8 */);
+    const offset = this.#getOffset(1 /* SizeOf.UINT8 */);
+    this.#assertRead(offset);
     const value = this.#dataView.getUint8(this.#offset);
-    this.#seek(1 /* SizeOf.UINT8 */);
+    this.#seek(offset);
     return value;
   }
   /**
@@ -366,9 +378,10 @@ class Buffer {
    * @returns {number} 介于 -32768 和 32767 之间的 16 位有符号整数
    */
   readInt16(littleEndian) {
-    this.#assertRead(2 /* SizeOf.INT16 */);
+    const offset = this.#getOffset(2 /* SizeOf.INT16 */);
+    this.#assertRead(offset);
     const value = this.#dataView.getInt16(this.#offset, littleEndian);
-    this.#seek(2 /* SizeOf.INT16 */);
+    this.#seek(offset);
     return value;
   }
   /**
@@ -378,9 +391,10 @@ class Buffer {
    * @returns {number} 介于 0 和 65535 之间的 16 位无符号整数
    */
   readUint16(littleEndian) {
-    this.#assertRead(2 /* SizeOf.UINT16 */);
+    const offset = this.#getOffset(2 /* SizeOf.UINT16 */);
+    this.#assertRead(offset);
     const value = this.#dataView.getUint16(this.#offset, littleEndian);
-    this.#seek(2 /* SizeOf.UINT16 */);
+    this.#seek(offset);
     return value;
   }
   /**
@@ -390,9 +404,10 @@ class Buffer {
    * @returns {number} 介于 -2147483648 和 2147483647 之间的 32 位有符号整数
    */
   readInt32(littleEndian) {
-    this.#assertRead(4 /* SizeOf.INT32 */);
+    const offset = this.#getOffset(4 /* SizeOf.INT32 */);
+    this.#assertRead(offset);
     const value = this.#dataView.getInt32(this.#offset, littleEndian);
-    this.#seek(4 /* SizeOf.INT32 */);
+    this.#seek(offset);
     return value;
   }
   /**
@@ -402,9 +417,10 @@ class Buffer {
    * @returns {number} 介于 0 和 4294967295 之间的 32 位无符号整数
    */
   readUint32(littleEndian) {
-    this.#assertRead(4 /* SizeOf.UINT32 */);
+    const offset = this.#getOffset(4 /* SizeOf.UINT32 */);
+    this.#assertRead(offset);
     const value = this.#dataView.getUint32(this.#offset, littleEndian);
-    this.#seek(4 /* SizeOf.UINT32 */);
+    this.#seek(offset);
     return value;
   }
   /**
@@ -414,9 +430,10 @@ class Buffer {
    * @returns {bigint} 介于 -9223372036854775808 和 9223372036854775807 之间的 64 位有符号整数
    */
   readInt64(littleEndian) {
-    this.#assertRead(8 /* SizeOf.INT64 */);
+    const offset = this.#getOffset(8 /* SizeOf.INT64 */);
+    this.#assertRead(offset);
     const value = this.#dataView.getBigInt64(this.#offset, littleEndian);
-    this.#seek(8 /* SizeOf.INT64 */);
+    this.#seek(offset);
     return value;
   }
   /**
@@ -426,9 +443,10 @@ class Buffer {
    * @returns {bigint} 介于 0 和 18446744073709551615 之间的 64 位无符号整数
    */
   readUint64(littleEndian) {
-    this.#assertRead(8 /* SizeOf.UINT64 */);
+    const offset = this.#getOffset(8 /* SizeOf.UINT64 */);
+    this.#assertRead(offset);
     const value = this.#dataView.getBigUint64(this.#offset, littleEndian);
-    this.#seek(8 /* SizeOf.UINT64 */);
+    this.#seek(offset);
     return value;
   }
   /**
@@ -438,9 +456,10 @@ class Buffer {
    * @returns {number} 单精度 32 位浮点数
    */
   readFloat32(littleEndian) {
-    this.#assertRead(4 /* SizeOf.FLOAT32 */);
+    const offset = this.#getOffset(4 /* SizeOf.FLOAT32 */);
+    this.#assertRead(offset);
     const value = this.#dataView.getFloat32(this.#offset, littleEndian);
-    this.#seek(4 /* SizeOf.FLOAT32 */);
+    this.#seek(offset);
     return value;
   }
   /**
@@ -450,16 +469,20 @@ class Buffer {
    * @returns {number} 双精度 64 位浮点数
    */
   readFloat64(littleEndian) {
-    this.#assertRead(8 /* SizeOf.FLOAT64 */);
+    const offset = this.#getOffset(8 /* SizeOf.FLOAT64 */);
+    this.#assertRead(offset);
     const value = this.#dataView.getFloat64(this.#offset, littleEndian);
-    this.#seek(8 /* SizeOf.FLOAT64 */);
+    this.#seek(offset);
     return value;
   }
   read(length, encoding) {
-    this.#assertRead(length);
-    const offset = this.#offset;
-    const bytes = this.#bytes.slice(offset, offset + length);
-    this.#seek(length);
+    if (!utils.isNaturalNumber(length)) {
+      throw new RangeError(errors.readLengthInvalid);
+    }
+    const offset = this.#getOffset(length);
+    this.#assertRead(offset);
+    const bytes = this.#bytes.slice(this.#offset, offset);
+    this.#seek(offset);
     if (arguments.length >= 2) {
       return index.decode(bytes, encoding);
     }
@@ -490,6 +513,30 @@ class Buffer {
     this.#bytes.copyWithin(target, start, end);
     return this;
   }
+  /**
+   * @method entries
+   * @description 获取迭代器
+   * @returns {IterableIterator<[number, number]>}
+   */
+  *entries() {
+    const bytes = this.bytes;
+    const length = this.#length;
+    for (let i = 0; i < length; i++) {
+      yield [i, bytes[i]];
+    }
+  }
+  /**
+   * @method values
+   * @description 获取迭代器
+   * @returns {IterableIterator<number>}
+   */
+  *values() {
+    const bytes = this.bytes;
+    const length = this.#length;
+    for (let i = 0; i < length; i++) {
+      yield bytes[i];
+    }
+  }
   /**
    * @override
    * @method toString
@@ -508,7 +555,21 @@ class Buffer {
     // 返回二进制编码
     return binary;
   }
+  /**
+   * @method iterator
+   * @description 迭代器
+   * @returns {IterableIterator<number>}
+   */
+  [Symbol.iterator]() {
+    return this.values();
+  }
 }
 
+Object.defineProperty(exports, 'Endian', {
+  enumerable: true,
+  get: function () {
+    return _enum.Endian;
+  }
+});
 exports.Buffer = Buffer;
 exports.endianness = endianness;