@yume-chan/struct 0.0.18 → 0.0.20

package/esm/types/number.d.ts

@@ -1,27 +1,28 @@
-import { StructFieldDefinition, StructFieldValue, type StructAsyncDeserializeStream, type StructDeserializeStream, type StructOptions, type StructValue } from "../basic/index.js";
-export interface NumberFieldType {
-    signed: boolean;
-    size: number;
-    deserialize(array: Uint8Array, littleEndian: boolean): number;
-    serialize(dataView: DataView, offset: number, value: number, littleEndian: boolean): void;
-}
-export declare namespace NumberFieldType {
-    const Uint8: NumberFieldType;
-    const Int8: NumberFieldType;
-    const Uint16: NumberFieldType;
-    const Int16: NumberFieldType;
-    const Uint32: NumberFieldType;
-    const Int32: NumberFieldType;
-}
-export declare class NumberFieldDefinition<TType extends NumberFieldType = NumberFieldType, TTypeScriptType = number> extends StructFieldDefinition<void, TTypeScriptType> {
-    readonly type: TType;
-    constructor(type: TType, typescriptType?: TTypeScriptType);
-    getSize(): number;
-    create(options: Readonly<StructOptions>, struct: StructValue, value: TTypeScriptType): NumberFieldValue<this>;
-    deserialize(options: Readonly<StructOptions>, stream: StructDeserializeStream, struct: StructValue): NumberFieldValue<this>;
-    deserialize(options: Readonly<StructOptions>, stream: StructAsyncDeserializeStream, struct: StructValue): Promise<NumberFieldValue<this>>;
-}
-export declare class NumberFieldValue<TDefinition extends NumberFieldDefinition<NumberFieldType, any>> extends StructFieldValue<TDefinition> {
-    serialize(dataView: DataView, offset: number): void;
-}
+import type { AsyncExactReadable, ExactReadable, StructOptions, StructValue } from "../basic/index.js";
+import { StructFieldDefinition, StructFieldValue } from "../basic/index.js";
+export interface NumberFieldType {
+    signed: boolean;
+    size: number;
+    deserialize(array: Uint8Array, littleEndian: boolean): number;
+    serialize(dataView: DataView, offset: number, value: number, littleEndian: boolean): void;
+}
+export declare namespace NumberFieldType {
+    const Uint8: NumberFieldType;
+    const Int8: NumberFieldType;
+    const Uint16: NumberFieldType;
+    const Int16: NumberFieldType;
+    const Uint32: NumberFieldType;
+    const Int32: NumberFieldType;
+}
+export declare class NumberFieldDefinition<TType extends NumberFieldType = NumberFieldType, TTypeScriptType = number> extends StructFieldDefinition<void, TTypeScriptType> {
+    readonly type: TType;
+    constructor(type: TType, typescriptType?: TTypeScriptType);
+    getSize(): number;
+    create(options: Readonly<StructOptions>, struct: StructValue, value: TTypeScriptType): NumberFieldValue<this>;
+    deserialize(options: Readonly<StructOptions>, stream: ExactReadable, struct: StructValue): NumberFieldValue<this>;
+    deserialize(options: Readonly<StructOptions>, stream: AsyncExactReadable, struct: StructValue): Promise<NumberFieldValue<this>>;
+}
+export declare class NumberFieldValue<TDefinition extends NumberFieldDefinition<NumberFieldType, any>> extends StructFieldValue<TDefinition> {
+    serialize(dataView: DataView, offset: number): void;
+}
 //# sourceMappingURL=number.d.ts.map

package/esm/types/number.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"number.d.ts","sourceRoot":"","sources":["../../src/types/number.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,qBAAqB,EACrB,gBAAgB,EAChB,KAAK,4BAA4B,EACjC,KAAK,uBAAuB,EAC5B,KAAK,aAAa,EAClB,KAAK,WAAW,EACnB,MAAM,mBAAmB,CAAC;AAI3B,MAAM,WAAW,eAAe;IAC5B,MAAM,EAAE,OAAO,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,KAAK,EAAE,UAAU,EAAE,YAAY,EAAE,OAAO,GAAG,MAAM,CAAC;IAC9D,SAAS,CACL,QAAQ,EAAE,QAAQ,EAClB,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,MAAM,EACb,YAAY,EAAE,OAAO,GACtB,IAAI,CAAC;CACX;AAGD,yBAAiB,eAAe,CAAC;IACtB,MAAM,KAAK,EAAE,eASnB,CAAC;IAEK,MAAM,IAAI,EAAE,eAUlB,CAAC;IAEK,MAAM,MAAM,EAAE,eAiBpB,CAAC;IAEK,MAAM,KAAK,EAAE,eAUnB,CAAC;IAEK,MAAM,MAAM,EAAE,eAUpB,CAAC;IAEK,MAAM,KAAK,EAAE,eAoBnB,CAAC;CACL;AAED,qBAAa,qBAAqB,CAC9B,KAAK,SAAS,eAAe,GAAG,eAAe,EAC/C,eAAe,GAAG,MAAM,CAC1B,SAAQ,qBAAqB,CAAC,IAAI,EAAE,eAAe,CAAC;IAClD,SAAgB,IAAI,EAAE,KAAK,CAAC;gBAET,IAAI,EAAE,KAAK,EAAE,cAAc,CAAC,EAAE,eAAe;IAMzD,OAAO,IAAI,MAAM;IAIjB,MAAM,CACT,OAAO,EAAE,QAAQ,CAAC,aAAa,CAAC,EAChC,MAAM,EAAE,WAAW,EACnB,KAAK,EAAE,eAAe,GACvB,gBAAgB,CAAC,IAAI,CAAC;IAIT,WAAW,CACvB,OAAO,EAAE,QAAQ,CAAC,aAAa,CAAC,EAChC,MAAM,EAAE,uBAAuB,EAC/B,MAAM,EAAE,WAAW,GACpB,gBAAgB,CAAC,IAAI,CAAC;IACT,WAAW,CACvB,OAAO,EAAE,QAAQ,CAAC,aAAa,CAAC,EAChC,MAAM,EAAE,4BAA4B,EACpC,MAAM,EAAE,WAAW,GACpB,OAAO,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;CAkBrC;AAED,qBAAa,gBAAgB,CACzB,WAAW,SAAS,qBAAqB,CAAC,eAAe,EAAE,GAAG,CAAC,CACjE,SAAQ,gBAAgB,CAAC,WAAW,CAAC;IAC5B,SAAS,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI;CAQ7D"}
+{"version":3,"file":"number.d.ts","sourceRoot":"","sources":["../../src/types/number.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACR,kBAAkB,EAClB,aAAa,EACb,aAAa,EACb,WAAW,EACd,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAI5E,MAAM,WAAW,eAAe;IAC5B,MAAM,EAAE,OAAO,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,KAAK,EAAE,UAAU,EAAE,YAAY,EAAE,OAAO,GAAG,MAAM,CAAC;IAC9D,SAAS,CACL,QAAQ,EAAE,QAAQ,EAClB,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,MAAM,EACb,YAAY,EAAE,OAAO,GACtB,IAAI,CAAC;CACX;AAGD,yBAAiB,eAAe,CAAC;IACtB,MAAM,KAAK,EAAE,eASnB,CAAC;IAEK,MAAM,IAAI,EAAE,eAUlB,CAAC;IAEK,MAAM,MAAM,EAAE,eAcpB,CAAC;IAEK,MAAM,KAAK,EAAE,eAUnB,CAAC;IAEK,MAAM,MAAM,EAAE,eAUpB,CAAC;IAEK,MAAM,KAAK,EAAE,eAmBnB,CAAC;CACL;AAED,qBAAa,qBAAqB,CAC9B,KAAK,SAAS,eAAe,GAAG,eAAe,EAC/C,eAAe,GAAG,MAAM,CAC1B,SAAQ,qBAAqB,CAAC,IAAI,EAAE,eAAe,CAAC;IAClD,SAAgB,IAAI,EAAE,KAAK,CAAC;gBAET,IAAI,EAAE,KAAK,EAAE,cAAc,CAAC,EAAE,eAAe;IAMzD,OAAO,IAAI,MAAM;IAIjB,MAAM,CACT,OAAO,EAAE,QAAQ,CAAC,aAAa,CAAC,EAChC,MAAM,EAAE,WAAW,EACnB,KAAK,EAAE,eAAe,GACvB,gBAAgB,CAAC,IAAI,CAAC;IAIT,WAAW,CACvB,OAAO,EAAE,QAAQ,CAAC,aAAa,CAAC,EAChC,MAAM,EAAE,aAAa,EACrB,MAAM,EAAE,WAAW,GACpB,gBAAgB,CAAC,IAAI,CAAC;IACT,WAAW,CACvB,OAAO,EAAE,QAAQ,CAAC,aAAa,CAAC,EAChC,MAAM,EAAE,kBAAkB,EAC1B,MAAM,EAAE,WAAW,GACpB,OAAO,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;CAkBrC;AAED,qBAAa,gBAAgB,CACzB,WAAW,SAAS,qBAAqB,CAAC,eAAe,EAAE,GAAG,CAAC,CACjE,SAAQ,gBAAgB,CAAC,WAAW,CAAC;IAC5B,SAAS,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI;CAQ7D"}

package/esm/types/number.js

@@ -1,114 +1,112 @@
-import { StructFieldDefinition, StructFieldValue, } from "../basic/index.js";
-import { SyncPromise } from "../sync-promise.js";
-// eslint-disable-next-line @typescript-eslint/no-namespace
-export var NumberFieldType;
-(function (NumberFieldType) {
-    NumberFieldType.Uint8 = {
-        signed: false,
-        size: 1,
-        deserialize(array) {
-            return array[0];
-        },
-        serialize(dataView, offset, value) {
-            dataView.setUint8(offset, value);
-        },
-    };
-    NumberFieldType.Int8 = {
-        signed: true,
-        size: 1,
-        deserialize(array) {
-            const value = NumberFieldType.Uint8.deserialize(array, false);
-            return (value << 24) >> 24;
-        },
-        serialize(dataView, offset, value) {
-            dataView.setInt8(offset, value);
-        },
-    };
-    NumberFieldType.Uint16 = {
-        signed: false,
-        size: 2,
-        deserialize(array, littleEndian) {
-            // PERF: Chrome's `DataView#getUint16` uses inefficient operations,
-            // including branching, bit extending and 32-bit bit swapping.
-            // The best way should use 16-bit bit rotation and conditional move,
-            // like LLVM does for code similar to the below one.
-            // This code is much faster on V8, but the actual generated assembly is unknown.
-            return ((((array[1] << 8) | array[0]) * littleEndian) |
-                (((array[0] << 8) | array[1]) * !littleEndian));
-        },
-        serialize(dataView, offset, value, littleEndian) {
-            dataView.setUint16(offset, value, littleEndian);
-        },
-    };
-    NumberFieldType.Int16 = {
-        signed: true,
-        size: 2,
-        deserialize(array, littleEndian) {
-            const value = NumberFieldType.Uint16.deserialize(array, littleEndian);
-            return (value << 16) >> 16;
-        },
-        serialize(dataView, offset, value, littleEndian) {
-            dataView.setInt16(offset, value, littleEndian);
-        },
-    };
-    NumberFieldType.Uint32 = {
-        signed: false,
-        size: 4,
-        deserialize(array, littleEndian) {
-            const value = NumberFieldType.Int32.deserialize(array, littleEndian);
-            return value >>> 0;
-        },
-        serialize(dataView, offset, value, littleEndian) {
-            dataView.setUint32(offset, value, littleEndian);
-        },
-    };
-    NumberFieldType.Int32 = {
-        signed: true,
-        size: 4,
-        deserialize(array, littleEndian) {
-            return ((((array[3] << 24) |
-                (array[2] << 16) |
-                (array[1] << 8) |
-                array[0]) *
-                littleEndian) |
-                (((array[0] << 24) |
-                    (array[1] << 16) |
-                    (array[2] << 8) |
-                    array[3]) *
-                    !littleEndian));
-        },
-        serialize(dataView, offset, value, littleEndian) {
-            dataView.setInt32(offset, value, littleEndian);
-        },
-    };
-})(NumberFieldType = NumberFieldType || (NumberFieldType = {}));
-export class NumberFieldDefinition extends StructFieldDefinition {
-    type;
-    constructor(type, typescriptType) {
-        void typescriptType;
-        super();
-        this.type = type;
-    }
-    getSize() {
-        return this.type.size;
-    }
-    create(options, struct, value) {
-        return new NumberFieldValue(this, options, struct, value);
-    }
-    deserialize(options, stream, struct) {
-        return SyncPromise.try(() => {
-            return stream.read(this.getSize());
-        })
-            .then((array) => {
-            const value = this.type.deserialize(array, options.littleEndian);
-            return this.create(options, struct, value);
-        })
-            .valueOrPromise();
-    }
-}
-export class NumberFieldValue extends StructFieldValue {
-    serialize(dataView, offset) {
-        this.definition.type.serialize(dataView, offset, this.value, this.options.littleEndian);
-    }
-}
+import { StructFieldDefinition, StructFieldValue } from "../basic/index.js";
+import { SyncPromise } from "../sync-promise.js";
+// eslint-disable-next-line @typescript-eslint/no-namespace
+export var NumberFieldType;
+(function (NumberFieldType) {
+    NumberFieldType.Uint8 = {
+        signed: false,
+        size: 1,
+        deserialize(array) {
+            return array[0];
+        },
+        serialize(dataView, offset, value) {
+            dataView.setUint8(offset, value);
+        },
+    };
+    NumberFieldType.Int8 = {
+        signed: true,
+        size: 1,
+        deserialize(array) {
+            const value = NumberFieldType.Uint8.deserialize(array, false);
+            return (value << 24) >> 24;
+        },
+        serialize(dataView, offset, value) {
+            dataView.setInt8(offset, value);
+        },
+    };
+    NumberFieldType.Uint16 = {
+        signed: false,
+        size: 2,
+        deserialize(array, littleEndian) {
+            // PERF: Creating many `DataView`s over small buffers is 90% slower
+            // than this. Even if the `DataView` is cached, `DataView#getUint16`
+            // is still 1% slower than this.
+            const a = (array[1] << 8) | array[0];
+            const b = (array[0] << 8) | array[1];
+            return littleEndian ? a : b;
+        },
+        serialize(dataView, offset, value, littleEndian) {
+            dataView.setUint16(offset, value, littleEndian);
+        },
+    };
+    NumberFieldType.Int16 = {
+        signed: true,
+        size: 2,
+        deserialize(array, littleEndian) {
+            const value = NumberFieldType.Uint16.deserialize(array, littleEndian);
+            return (value << 16) >> 16;
+        },
+        serialize(dataView, offset, value, littleEndian) {
+            dataView.setInt16(offset, value, littleEndian);
+        },
+    };
+    NumberFieldType.Uint32 = {
+        signed: false,
+        size: 4,
+        deserialize(array, littleEndian) {
+            const value = NumberFieldType.Int32.deserialize(array, littleEndian);
+            return value >>> 0;
+        },
+        serialize(dataView, offset, value, littleEndian) {
+            dataView.setUint32(offset, value, littleEndian);
+        },
+    };
+    NumberFieldType.Int32 = {
+        signed: true,
+        size: 4,
+        deserialize(array, littleEndian) {
+            const a = (array[3] << 24) |
+                (array[2] << 16) |
+                (array[1] << 8) |
+                array[0];
+            const b = (array[0] << 24) |
+                (array[1] << 16) |
+                (array[2] << 8) |
+                array[3];
+            return littleEndian ? a : b;
+        },
+        serialize(dataView, offset, value, littleEndian) {
+            dataView.setInt32(offset, value, littleEndian);
+        },
+    };
+})(NumberFieldType = NumberFieldType || (NumberFieldType = {}));
+export class NumberFieldDefinition extends StructFieldDefinition {
+    type;
+    constructor(type, typescriptType) {
+        void typescriptType;
+        super();
+        this.type = type;
+    }
+    getSize() {
+        return this.type.size;
+    }
+    create(options, struct, value) {
+        return new NumberFieldValue(this, options, struct, value);
+    }
+    deserialize(options, stream, struct) {
+        return SyncPromise.try(() => {
+            return stream.readExactly(this.getSize());
+        })
+            .then((array) => {
+            const value = this.type.deserialize(array, options.littleEndian);
+            return this.create(options, struct, value);
+        })
+            .valueOrPromise();
+    }
+}
+export class NumberFieldValue extends StructFieldValue {
+    serialize(dataView, offset) {
+        this.definition.type.serialize(dataView, offset, this.value, this.options.littleEndian);
+    }
+}
 //# sourceMappingURL=number.js.map

package/esm/types/number.js.map

@@ -1 +1 @@
-{"version":3,"file":"number.js","sourceRoot":"","sources":["../../src/types/number.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,qBAAqB,EACrB,gBAAgB,GAKnB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAejD,2DAA2D;AAC3D,MAAM,KAAW,eAAe,CAwF/B;AAxFD,WAAiB,eAAe;IACf,qBAAK,GAAoB;QAClC,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,CAAC;QACP,WAAW,CAAC,KAAK;YACb,OAAO,KAAK,CAAC,CAAC,CAAE,CAAC;QACrB,CAAC;QACD,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK;YAC7B,QAAQ,CAAC,QAAQ,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QACrC,CAAC;KACJ,CAAC;IAEW,oBAAI,GAAoB;QACjC,MAAM,EAAE,IAAI;QACZ,IAAI,EAAE,CAAC;QACP,WAAW,CAAC,KAAK;YACb,MAAM,KAAK,GAAG,gBAAA,KAAK,CAAC,WAAW,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;YAC9C,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC;QAC/B,CAAC;QACD,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK;YAC7B,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QACpC,CAAC;KACJ,CAAC;IAEW,sBAAM,GAAoB;QACnC,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,CAAC;QACP,WAAW,CAAC,KAAK,EAAE,YAAY;YAC3B,mEAAmE;YACnE,8DAA8D;YAC9D,oEAAoE;YACpE,oDAAoD;YACpD,gFAAgF;YAChF,OAAO,CACH,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAE,IAAI,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAE,CAAC,GAAI,YAAoB,CAAC;gBACxD,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAE,IAAI,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAE,CAAC,GAAI,CAAC,YAAoB,CAAC,CAC5D,CAAC;QACN,CAAC;QACD,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY;YAC3C,QAAQ,CAAC,SAAS,CAAC,MAAM,EAAE,KAAK,EAAE,YAAY,CAAC,CAAC;QACpD,CAAC;KACJ,CAAC;IAEW,qBAAK,GAAoB;QAClC,MAAM,EAAE,IAAI;QACZ,IAAI,EAAE,CAAC;QACP,WAAW,CAAC,KAAK,EAAE,YAAY;YAC3B,MAAM,KAAK,GAAG,gBAAA,MAAM,CAAC,WAAW,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;YACtD,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC;QAC/B,CAAC;QACD,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY;YAC3C,QAAQ,CAAC,QAAQ,CAAC,MAAM,EAAE,KAAK,EAAE,YAAY,CAAC,CAAC;QACnD,CAAC;KACJ,CAAC;IAEW,sBAAM,GAAoB;QACnC,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,CAAC;QACP,WAAW,CAAC,KAAK,EAAE,YAAY;YAC3B,MAAM,KAAK,GAAG,gBAAA,KAAK,CAAC,WAAW,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;YACrD,OAAO,KAAK,KAAK,CAAC,CAAC;QACvB,CAAC;QACD,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY;YAC3C,QAAQ,CAAC,SAAS,CAAC,MAAM,EAAE,KAAK,EAAE,YAAY,CAAC,CAAC;QACpD,CAAC;KACJ,CAAC;IAEW,qBAAK,GAAoB;QAClC,MAAM,EAAE,IAAI;QACZ,IAAI,EAAE,CAAC;QACP,WAAW,CAAC,KAAK,EAAE,YAAY;YAC3B,OAAO,CACH,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAE,IAAI,EAAE,CAAC;gBACf,CAAC,KAAK,CAAC,CAAC,CAAE,IAAI,EAAE,CAAC;gBACjB,CAAC,KAAK,CAAC,CAAC,CAAE,IAAI,CAAC,CAAC;gBAChB,KAAK,CAAC,CAAC,CAAE,CAAC;gBACT,YAAoB,CAAC;gBAC1B,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAE,IAAI,EAAE,CAAC;oBACf,CAAC,KAAK,CAAC,CAAC,CAAE,IAAI,EAAE,CAAC;oBACjB,CAAC,KAAK,CAAC,CAAC,CAAE,IAAI,CAAC,CAAC;oBAChB,KAAK,CAAC,CAAC,CAAE,CAAC;oBACT,CAAC,YAAoB,CAAC,CAC9B,CAAC;QACN,CAAC;QACD,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY;YAC3C,QAAQ,CAAC,QAAQ,CAAC,MAAM,EAAE,KAAK,EAAE,YAAY,CAAC,CAAC;QACnD,CAAC;KACJ,CAAC;AACN,CAAC,EAxFgB,eAAe,GAAf,eAAe,KAAf,eAAe,QAwF/B;AAED,MAAM,OAAO,qBAGX,SAAQ,qBAA4C;IAClC,IAAI,CAAQ;IAE5B,YAAmB,IAAW,EAAE,cAAgC;QAC5D,KAAK,cAAc,CAAC;QACpB,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACrB,CAAC;IAEM,OAAO;QACV,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;IAC1B,CAAC;IAEM,MAAM,CACT,OAAgC,EAChC,MAAmB,EACnB,KAAsB;QAEtB,OAAO,IAAI,gBAAgB,CAAC,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;IAC9D,CAAC;IAYe,WAAW,CACvB,OAAgC,EAChC,MAA8D,EAC9D,MAAmB;QAEnB,OAAO,WAAW,CAAC,GAAG,CAAC,GAAG,EAAE;YACxB,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;QACvC,CAAC,CAAC;aACG,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE;YACZ,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,CAC/B,KAAK,EACL,OAAO,CAAC,YAAY,CACvB,CAAC;YACF,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,KAAY,CAAC,CAAC;QACtD,CAAC,CAAC;aACD,cAAc,EAAE,CAAC;IAC1B,CAAC;CACJ;AAED,MAAM,OAAO,gBAEX,SAAQ,gBAA6B;IAC5B,SAAS,CAAC,QAAkB,EAAE,MAAc;QAC/C,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAC1B,QAAQ,EACR,MAAM,EACN,IAAI,CAAC,KAAK,EACV,IAAI,CAAC,OAAO,CAAC,YAAY,CAC5B,CAAC;IACN,CAAC;CACJ"}
+{"version":3,"file":"number.js","sourceRoot":"","sources":["../../src/types/number.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAC5E,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAejD,2DAA2D;AAC3D,MAAM,KAAW,eAAe,CAoF/B;AApFD,WAAiB,eAAe;IACf,qBAAK,GAAoB;QAClC,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,CAAC;QACP,WAAW,CAAC,KAAK;YACb,OAAO,KAAK,CAAC,CAAC,CAAE,CAAC;QACrB,CAAC;QACD,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK;YAC7B,QAAQ,CAAC,QAAQ,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QACrC,CAAC;KACJ,CAAC;IAEW,oBAAI,GAAoB;QACjC,MAAM,EAAE,IAAI;QACZ,IAAI,EAAE,CAAC;QACP,WAAW,CAAC,KAAK;YACb,MAAM,KAAK,GAAG,gBAAA,KAAK,CAAC,WAAW,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;YAC9C,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC;QAC/B,CAAC;QACD,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK;YAC7B,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QACpC,CAAC;KACJ,CAAC;IAEW,sBAAM,GAAoB;QACnC,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,CAAC;QACP,WAAW,CAAC,KAAK,EAAE,YAAY;YAC3B,mEAAmE;YACnE,oEAAoE;YACpE,gCAAgC;YAChC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAE,IAAI,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAE,CAAC;YACvC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAE,IAAI,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAE,CAAC;YACvC,OAAO,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAChC,CAAC;QACD,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY;YAC3C,QAAQ,CAAC,SAAS,CAAC,MAAM,EAAE,KAAK,EAAE,YAAY,CAAC,CAAC;QACpD,CAAC;KACJ,CAAC;IAEW,qBAAK,GAAoB;QAClC,MAAM,EAAE,IAAI;QACZ,IAAI,EAAE,CAAC;QACP,WAAW,CAAC,KAAK,EAAE,YAAY;YAC3B,MAAM,KAAK,GAAG,gBAAA,MAAM,CAAC,WAAW,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;YACtD,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC;QAC/B,CAAC;QACD,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY;YAC3C,QAAQ,CAAC,QAAQ,CAAC,MAAM,EAAE,KAAK,EAAE,YAAY,CAAC,CAAC;QACnD,CAAC;KACJ,CAAC;IAEW,sBAAM,GAAoB;QACnC,MAAM,EAAE,KAAK;QACb,IAAI,EAAE,CAAC;QACP,WAAW,CAAC,KAAK,EAAE,YAAY;YAC3B,MAAM,KAAK,GAAG,gBAAA,KAAK,CAAC,WAAW,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;YACrD,OAAO,KAAK,KAAK,CAAC,CAAC;QACvB,CAAC;QACD,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY;YAC3C,QAAQ,CAAC,SAAS,CAAC,MAAM,EAAE,KAAK,EAAE,YAAY,CAAC,CAAC;QACpD,CAAC;KACJ,CAAC;IAEW,qBAAK,GAAoB;QAClC,MAAM,EAAE,IAAI;QACZ,IAAI,EAAE,CAAC;QACP,WAAW,CAAC,KAAK,EAAE,YAAY;YAC3B,MAAM,CAAC,GACH,CAAC,KAAK,CAAC,CAAC,CAAE,IAAI,EAAE,CAAC;gBACjB,CAAC,KAAK,CAAC,CAAC,CAAE,IAAI,EAAE,CAAC;gBACjB,CAAC,KAAK,CAAC,CAAC,CAAE,IAAI,CAAC,CAAC;gBAChB,KAAK,CAAC,CAAC,CAAE,CAAC;YACd,MAAM,CAAC,GACH,CAAC,KAAK,CAAC,CAAC,CAAE,IAAI,EAAE,CAAC;gBACjB,CAAC,KAAK,CAAC,CAAC,CAAE,IAAI,EAAE,CAAC;gBACjB,CAAC,KAAK,CAAC,CAAC,CAAE,IAAI,CAAC,CAAC;gBAChB,KAAK,CAAC,CAAC,CAAE,CAAC;YACd,OAAO,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAChC,CAAC;QACD,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY;YAC3C,QAAQ,CAAC,QAAQ,CAAC,MAAM,EAAE,KAAK,EAAE,YAAY,CAAC,CAAC;QACnD,CAAC;KACJ,CAAC;AACN,CAAC,EApFgB,eAAe,GAAf,eAAe,KAAf,eAAe,QAoF/B;AAED,MAAM,OAAO,qBAGX,SAAQ,qBAA4C;IAClC,IAAI,CAAQ;IAE5B,YAAmB,IAAW,EAAE,cAAgC;QAC5D,KAAK,cAAc,CAAC;QACpB,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACrB,CAAC;IAEM,OAAO;QACV,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;IAC1B,CAAC;IAEM,MAAM,CACT,OAAgC,EAChC,MAAmB,EACnB,KAAsB;QAEtB,OAAO,IAAI,gBAAgB,CAAC,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;IAC9D,CAAC;IAYe,WAAW,CACvB,OAAgC,EAChC,MAA0C,EAC1C,MAAmB;QAEnB,OAAO,WAAW,CAAC,GAAG,CAAC,GAAG,EAAE;YACxB,OAAO,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;QAC9C,CAAC,CAAC;aACG,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE;YACZ,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,CAC/B,KAAK,EACL,OAAO,CAAC,YAAY,CACvB,CAAC;YACF,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,KAAY,CAAC,CAAC;QACtD,CAAC,CAAC;aACD,cAAc,EAAE,CAAC;IAC1B,CAAC;CACJ;AAED,MAAM,OAAO,gBAEX,SAAQ,gBAA6B;IAC5B,SAAS,CAAC,QAAkB,EAAE,MAAc;QAC/C,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAC1B,QAAQ,EACR,MAAM,EACN,IAAI,CAAC,KAAK,EACV,IAAI,CAAC,OAAO,CAAC,YAAY,CAC5B,CAAC;IACN,CAAC;CACJ"}

package/esm/utils.d.ts

@@ -1,48 +1,48 @@
-/**
- * When evaluating a very complex generic type alias,
- * tell TypeScript to use `T`, instead of current type alias' name, as the result type name
- *
- * Example:
- *
- * ```ts
- * type WithIdentity<T> = Identity<SomeType<T>>;
- * type WithoutIdentity<T> = SomeType<T>;
- *
- * type WithIdentityResult = WithIdentity<number>;
- * // Hover on this one shows `SomeType<number>`
- *
- * type WithoutIdentityResult = WithoutIdentity<number>;
- * // Hover on this one shows `WithoutIdentity<number>`
- * ```
- */
-export type Identity<T> = T;
-/**
- * Collapse an intersection type (`{ foo: string } & { bar: number }`) to a simple type (`{ foo: string, bar: number }`)
- */
-export type Evaluate<T> = T extends infer U ? {
-    [K in keyof U]: U[K];
-} : never;
-/**
- * Overwrite fields in `TBase` with fields in `TNew`
- */
-export type Overwrite<TBase extends object, TNew extends object> = Evaluate<Omit<TBase, keyof TNew> & TNew>;
-/**
- * Remove fields with `never` type
- */
-export type OmitNever<T> = Pick<T, {
-    [K in keyof T]: [T[K]] extends [never] ? never : K;
-}[keyof T]>;
-/**
- * Extract keys of fields in `T` that has type `TValue`
- */
-export type KeysOfType<T, TValue> = {
-    [TKey in keyof T]: T[TKey] extends TValue ? TKey : never;
-}[keyof T];
-export type ValueOrPromise<T> = T | PromiseLike<T>;
-/**
- * Returns a (fake) value of the given type.
- */
-export declare function placeholder<T>(): T;
-export declare function encodeUtf8(input: string): Uint8Array;
-export declare function decodeUtf8(buffer: ArrayBufferView | ArrayBuffer): string;
+/**
+ * When evaluating a very complex generic type alias,
+ * tell TypeScript to use `T`, instead of current type alias' name, as the result type name
+ *
+ * Example:
+ *
+ * ```ts
+ * type WithIdentity<T> = Identity<SomeType<T>>;
+ * type WithoutIdentity<T> = SomeType<T>;
+ *
+ * type WithIdentityResult = WithIdentity<number>;
+ * // Hover on this one shows `SomeType<number>`
+ *
+ * type WithoutIdentityResult = WithoutIdentity<number>;
+ * // Hover on this one shows `WithoutIdentity<number>`
+ * ```
+ */
+export type Identity<T> = T;
+/**
+ * Collapse an intersection type (`{ foo: string } & { bar: number }`) to a simple type (`{ foo: string, bar: number }`)
+ */
+export type Evaluate<T> = T extends infer U ? {
+    [K in keyof U]: U[K];
+} : never;
+/**
+ * Overwrite fields in `TBase` with fields in `TNew`
+ */
+export type Overwrite<TBase extends object, TNew extends object> = Evaluate<Omit<TBase, keyof TNew> & TNew>;
+/**
+ * Remove fields with `never` type
+ */
+export type OmitNever<T> = Pick<T, {
+    [K in keyof T]: [T[K]] extends [never] ? never : K;
+}[keyof T]>;
+/**
+ * Extract keys of fields in `T` that has type `TValue`
+ */
+export type KeysOfType<T, TValue> = {
+    [TKey in keyof T]: T[TKey] extends TValue ? TKey : never;
+}[keyof T];
+export type ValueOrPromise<T> = T | PromiseLike<T>;
+/**
+ * Returns a (fake) value of the given type.
+ */
+export declare function placeholder<T>(): T;
+export declare function encodeUtf8(input: string): Uint8Array;
+export declare function decodeUtf8(buffer: ArrayBufferView | ArrayBuffer): string;
 //# sourceMappingURL=utils.d.ts.map

package/esm/utils.js

@@ -1,16 +1,16 @@
-/**
- * Returns a (fake) value of the given type.
- */
-export function placeholder() {
-    return undefined;
-}
-const { TextEncoder, TextDecoder } = globalThis;
-const Utf8Encoder = new TextEncoder();
-const Utf8Decoder = new TextDecoder();
-export function encodeUtf8(input) {
-    return Utf8Encoder.encode(input);
-}
-export function decodeUtf8(buffer) {
-    return Utf8Decoder.decode(buffer);
-}
+/**
+ * Returns a (fake) value of the given type.
+ */
+export function placeholder() {
+    return undefined;
+}
+const { TextEncoder, TextDecoder } = globalThis;
+const Utf8Encoder = new TextEncoder();
+const Utf8Decoder = new TextDecoder();
+export function encodeUtf8(input) {
+    return Utf8Encoder.encode(input);
+}
+export function decodeUtf8(buffer) {
+    return Utf8Decoder.decode(buffer);
+}
 //# sourceMappingURL=utils.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yume-chan/struct",
-  "version": "0.0.18",
+  "version": "0.0.20",
   "description": "C-style structure serializer and deserializer.",
   "keywords": [
     "structure",
@@ -27,23 +27,24 @@
   "main": "esm/index.js",
   "types": "esm/index.d.ts",
   "dependencies": {
-    "@yume-chan/dataview-bigint-polyfill": "^0.0.18",
-    "tslib": "^2.4.1"
+    "@yume-chan/dataview-bigint-polyfill": "^0.0.20",
+    "tslib": "^2.5.2"
   },
   "devDependencies": {
-    "@jest/globals": "^29.3.1",
+    "@jest/globals": "^29.5.0",
     "@yume-chan/eslint-config": "^1.0.0",
     "@yume-chan/tsconfig": "^1.0.0",
     "cross-env": "^7.0.3",
-    "eslint": "^8.31.0",
-    "jest": "^29.3.1",
+    "eslint": "^8.41.0",
+    "jest": "^29.5.0",
+    "prettier": "^2.8.8",
     "ts-jest": "^29.0.4",
-    "typescript": "^4.9.4"
+    "typescript": "^5.0.3"
   },
   "scripts": {
     "build": "tsc -b tsconfig.build.json",
     "build:watch": "tsc -b tsconfig.build.json",
     "test": "cross-env NODE_OPTIONS=--experimental-vm-modules jest --coverage",
-    "lint": "eslint src/**/*.ts --fix"
+    "lint": "eslint src/**/*.ts --fix && prettier src/**/*.ts --write --tab-width 4"
   }
 }

package/src/basic/definition.ts

@@ -1,10 +1,7 @@
-import { type StructFieldValue } from "./field-value.js";
-import { type StructOptions } from "./options.js";
-import {
-    type StructAsyncDeserializeStream,
-    type StructDeserializeStream,
-} from "./stream.js";
-import { type StructValue } from "./struct-value.js";
+import type { StructFieldValue } from "./field-value.js";
+import type { StructOptions } from "./options.js";
+import type { AsyncExactReadable, ExactReadable } from "./stream.js";
+import type { StructValue } from "./struct-value.js";
 
 /**
  * A field definition defines how to deserialize a field.
@@ -60,12 +57,12 @@ export abstract class StructFieldDefinition<
      */
     public abstract deserialize(
         options: Readonly<StructOptions>,
-        stream: StructDeserializeStream,
+        stream: ExactReadable,
         structValue: StructValue
     ): StructFieldValue<this>;
     public abstract deserialize(
         options: Readonly<StructOptions>,
-        stream: StructAsyncDeserializeStream,
+        stream: AsyncExactReadable,
         struct: StructValue
     ): Promise<StructFieldValue<this>>;
 }

package/src/basic/field-value.ts

@@ -1,6 +1,6 @@
-import { type StructFieldDefinition } from "./definition.js";
-import { type StructOptions } from "./options.js";
-import { type StructValue } from "./struct-value.js";
+import type { StructFieldDefinition } from "./definition.js";
+import type { StructOptions } from "./options.js";
+import type { StructValue } from "./struct-value.js";
 
 /**
  * A field value defines how to serialize a field.

package/src/basic/index.ts

@@ -1,5 +1,5 @@
-export * from './definition.js';
-export * from './field-value.js';
-export * from './options.js';
-export * from './stream.js';
-export * from './struct-value.js';
+export * from "./definition.js";
+export * from "./field-value.js";
+export * from "./options.js";
+export * from "./stream.js";
+export * from "./struct-value.js";

package/src/basic/stream.ts

@@ -1,23 +1,34 @@
-import { type ValueOrPromise } from "../utils.js";
+import type { ValueOrPromise } from "../utils.js";
 
 // TODO: allow over reading (returning a `Uint8Array`, an `offset` and a `length`) to avoid copying
 
-export interface StructDeserializeStream {
+export class ExactReadableEndedError extends Error {
+    public constructor() {
+        super("ExactReadable ended");
+        Object.setPrototypeOf(this, new.target.prototype);
+    }
+}
+
+export interface ExactReadable {
+    readonly position: number;
+
     /**
      * Read data from the underlying data source.
      *
      * The stream must return exactly `length` bytes or data. If that's not possible
-     * (due to end of file or other error condition), it must throw an error.
+     * (due to end of file or other error condition), it must throw an {@link ExactReadableEndedError}.
      */
-    read(length: number): Uint8Array;
+    readExactly(length: number): Uint8Array;
 }
 
-export interface StructAsyncDeserializeStream {
+export interface AsyncExactReadable {
+    readonly position: number;
+
     /**
      * Read data from the underlying data source.
      *
      * The stream must return exactly `length` bytes or data. If that's not possible
-     * (due to end of file or other error condition), it must throw an error.
+     * (due to end of file or other error condition), it must throw an {@link ExactReadableEndedError}.
      */
-    read(length: number): ValueOrPromise<Uint8Array>;
+    readExactly(length: number): ValueOrPromise<Uint8Array>;
 }

package/src/basic/struct-value.ts

@@ -1,4 +1,4 @@
-import { type StructFieldValue } from "./field-value.js";
+import type { StructFieldValue } from "./field-value.js";
 
 export const STRUCT_VALUE_SYMBOL = Symbol("struct-value");
 

package/src/index.ts

@@ -10,8 +10,9 @@ declare global {
     }
 }
 
-export * from './basic/index.js';
-export * from './struct.js';
-export { Struct as default } from './struct.js';
-export * from './types/index.js';
-export * from './utils.js';
+export * from "./basic/index.js";
+export * from "./struct.js";
+export { Struct as default } from "./struct.js";
+export * from "./sync-promise.js";
+export * from "./types/index.js";
+export * from "./utils.js";