@yume-chan/struct 0.0.0-20240714132542

package/esm/struct.js

@@ -0,0 +1,255 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import { ExactReadableEndedError, STRUCT_VALUE_SYMBOL, StructDefaultOptions, StructValue, isStructValueInit, } from "./basic/index.js";
+import { SyncPromise } from "./sync-promise.js";
+import { BigIntFieldDefinition, BigIntFieldVariant, FixedLengthBufferLikeFieldDefinition, NumberFieldDefinition, NumberFieldVariant, StringBufferFieldConverter, Uint8ArrayBufferFieldConverter, VariableLengthBufferLikeFieldDefinition, } from "./types/index.js";
+export class StructDeserializeError extends Error {
+    constructor(message) {
+        super(message);
+        Object.setPrototypeOf(this, new.target.prototype);
+    }
+}
+export class StructNotEnoughDataError extends StructDeserializeError {
+    constructor() {
+        super("The underlying readable was ended before the struct was fully deserialized");
+    }
+}
+export class StructEmptyError extends StructDeserializeError {
+    constructor() {
+        super("The underlying readable doesn't contain any more struct");
+    }
+}
+export class Struct {
+    TFields;
+    TOmitInitKey;
+    TExtra;
+    TInit;
+    TDeserializeResult;
+    options;
+    #size = 0;
+    /**
+     * Gets the static size (exclude fields that can change size at runtime)
+     */
+    get size() {
+        return this.#size;
+    }
+    #fields = [];
+    get fields() {
+        return this.#fields;
+    }
+    #extra = {};
+    #postDeserialized;
+    constructor(options) {
+        this.options = { ...StructDefaultOptions, ...options };
+    }
+    /**
+     * Appends a `StructFieldDefinition` to the `Struct
+     */
+    field(name, definition) {
+        for (const field of this.#fields) {
+            if (field[0] === name) {
+                // Convert Symbol to string
+                const nameString = String(name);
+                throw new Error(`This struct already have a field with name '${nameString}'`);
+            }
+        }
+        this.#fields.push([name, definition]);
+        const size = definition.getSize();
+        this.#size += size;
+        // Force cast `this` to another type
+        return this;
+    }
+    /**
+     * Merges (flats) another `Struct`'s fields and extra fields into this one.
+     *
+     * `other`'s `postDeserialize` will be ignored.
+     */
+    concat(other) {
+        if (!(other instanceof Struct)) {
+            throw new TypeError("The other value must be a `Struct` instance");
+        }
+        for (const field of other.#fields) {
+            this.#fields.push(field);
+        }
+        this.#size += other.#size;
+        Object.defineProperties(this.#extra, Object.getOwnPropertyDescriptors(other.#extra));
+        return this;
+    }
+    #number(name, type, typeScriptType) {
+        return this.field(name, new NumberFieldDefinition(type, typeScriptType));
+    }
+    /**
+     * Appends an `int8` field to the `Struct`
+     */
+    int8(name, typeScriptType) {
+        return this.#number(name, NumberFieldVariant.Int8, typeScriptType);
+    }
+    /**
+     * Appends an `uint8` field to the `Struct`
+     */
+    uint8(name, typeScriptType) {
+        return this.#number(name, NumberFieldVariant.Uint8, typeScriptType);
+    }
+    /**
+     * Appends an `int16` field to the `Struct`
+     */
+    int16(name, typeScriptType) {
+        return this.#number(name, NumberFieldVariant.Int16, typeScriptType);
+    }
+    /**
+     * Appends an `uint16` field to the `Struct`
+     */
+    uint16(name, typeScriptType) {
+        return this.#number(name, NumberFieldVariant.Uint16, typeScriptType);
+    }
+    /**
+     * Appends an `int32` field to the `Struct`
+     */
+    int32(name, typeScriptType) {
+        return this.#number(name, NumberFieldVariant.Int32, typeScriptType);
+    }
+    /**
+     * Appends an `uint32` field to the `Struct`
+     */
+    uint32(name, typeScriptType) {
+        return this.#number(name, NumberFieldVariant.Uint32, typeScriptType);
+    }
+    #bigint(name, type, typeScriptType) {
+        return this.field(name, new BigIntFieldDefinition(type, typeScriptType));
+    }
+    /**
+     * Appends an `int64` field to the `Struct`
+     *
+     * Requires native `BigInt` support
+     */
+    int64(name, typeScriptType) {
+        return this.#bigint(name, BigIntFieldVariant.Int64, typeScriptType);
+    }
+    /**
+     * Appends an `uint64` field to the `Struct`
+     *
+     * Requires native `BigInt` support
+     */
+    uint64(name, typeScriptType) {
+        return this.#bigint(name, BigIntFieldVariant.Uint64, typeScriptType);
+    }
+    #arrayBufferLike = (name, type, options) => {
+        if ("length" in options) {
+            return this.field(name, new FixedLengthBufferLikeFieldDefinition(type, options));
+        }
+        else {
+            return this.field(name, new VariableLengthBufferLikeFieldDefinition(type, options));
+        }
+    };
+    uint8Array = (name, options, typeScriptType) => {
+        return this.#arrayBufferLike(name, Uint8ArrayBufferFieldConverter.Instance, options, typeScriptType);
+    };
+    string = (name, options, typeScriptType) => {
+        return this.#arrayBufferLike(name, StringBufferFieldConverter.Instance, options, typeScriptType);
+    };
+    /**
+     * Adds some extra properties into every `Struct` value.
+     *
+     * Extra properties will not affect serialize or deserialize process.
+     *
+     * Multiple calls to `extra` will merge all properties together.
+     *
+     * @param value
+     * An object containing properties to be added to the result value. Accessors and methods are also allowed.
+     */
+    extra(value) {
+        Object.defineProperties(this.#extra, Object.getOwnPropertyDescriptors(value));
+        return this;
+    }
+    postDeserialize(callback) {
+        this.#postDeserialized = callback;
+        return this;
+    }
+    deserialize(stream) {
+        const structValue = new StructValue(this.#extra);
+        let promise = SyncPromise.resolve();
+        const startPosition = stream.position;
+        for (const [name, definition] of this.#fields) {
+            promise = promise
+                .then(() => definition.deserialize(this.options, stream, structValue))
+                .then((fieldValue) => {
+                structValue.set(name, fieldValue);
+            }, (e) => {
+                if (!(e instanceof ExactReadableEndedError)) {
+                    throw e;
+                }
+                if (stream.position === startPosition) {
+                    throw new StructEmptyError();
+                }
+                else {
+                    throw new StructNotEnoughDataError();
+                }
+            });
+        }
+        return promise
+            .then(() => {
+            const value = structValue.value;
+            // Run `postDeserialized`
+            if (this.#postDeserialized) {
+                const override = this.#postDeserialized.call(value, value);
+                // If it returns a new value, use that as result
+                // Otherwise it only inspects/mutates the object in place.
+                if (override !== undefined) {
+                    return override;
+                }
+            }
+            return value;
+        })
+            .valueOrPromise();
+    }
+    /**
+     * Serialize a struct value to a buffer.
+     * @param init Fields of the struct
+     * @param output The buffer to serialize the struct to. It must be large enough to hold the entire struct. If not provided, a new buffer will be created.
+     * @returns A view of `output` that contains the serialized struct, or a new buffer if `output` is not provided.
+     */
+    serialize(init, output) {
+        let structValue;
+        if (isStructValueInit(init)) {
+            structValue = init[STRUCT_VALUE_SYMBOL];
+            for (const [key, value] of Object.entries(init)) {
+                const fieldValue = structValue.get(key);
+                if (fieldValue) {
+                    fieldValue.set(value);
+                }
+            }
+        }
+        else {
+            structValue = new StructValue({});
+            for (const [name, definition] of this.#fields) {
+                const fieldValue = definition.create(this.options, structValue, init[name]);
+                structValue.set(name, fieldValue);
+            }
+        }
+        let structSize = 0;
+        const fieldsInfo = [];
+        for (const [name] of this.#fields) {
+            const fieldValue = structValue.get(name);
+            const size = fieldValue.getSize();
+            fieldsInfo.push({ fieldValue, size });
+            structSize += size;
+        }
+        if (!output) {
+            output = new Uint8Array(structSize);
+        }
+        else if (output.length < structSize) {
+            throw new TypeError("Output buffer is too small");
+        }
+        let offset = 0;
+        for (const { fieldValue, size } of fieldsInfo) {
+            fieldValue.serialize(output, offset);
+            offset += size;
+        }
+        if (output.length !== structSize) {
+            return output.subarray(0, structSize);
+        }
+        else {
+            return output;
+        }
+    }
+}
+//# sourceMappingURL=struct.js.map

package/esm/struct.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"struct.js","sourceRoot":"","sources":["../src/struct.ts"],"names":[],"mappings":"AAAA,uDAAuD;AASvD,OAAO,EACH,uBAAuB,EACvB,mBAAmB,EACnB,oBAAoB,EACpB,WAAW,EACX,iBAAiB,GACpB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAOhD,OAAO,EACH,qBAAqB,EACrB,kBAAkB,EAClB,oCAAoC,EACpC,qBAAqB,EACrB,kBAAkB,EAClB,0BAA0B,EAC1B,8BAA8B,EAC9B,uCAAuC,GAC1C,MAAM,kBAAkB,CAAC;AAmK1B,MAAM,OAAO,sBAAuB,SAAQ,KAAK;IAC7C,YAAY,OAAe;QACvB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IACtD,CAAC;CACJ;AAED,MAAM,OAAO,wBAAyB,SAAQ,sBAAsB;IAChE;QACI,KAAK,CACD,4EAA4E,CAC/E,CAAC;IACN,CAAC;CACJ;AAED,MAAM,OAAO,gBAAiB,SAAQ,sBAAsB;IACxD;QACI,KAAK,CAAC,yDAAyD,CAAC,CAAC;IACrE,CAAC;CACJ;AAgBD,MAAM,OAAO,MAAM;IAUN,OAAO,CAAW;IAElB,YAAY,CAAgB;IAE5B,MAAM,CAAU;IAEhB,KAAK,CAAyC;IAE9C,kBAAkB,CAIzB;IAEO,OAAO,CAA0B;IAE1C,KAAK,GAAG,CAAC,CAAC;IACV;;OAEG;IACH,IAAI,IAAI;QACJ,OAAO,IAAI,CAAC,KAAK,CAAC;IACtB,CAAC;IAED,OAAO,GAGD,EAAE,CAAC;IACT,IAAI,MAAM;QAIN,OAAO,IAAI,CAAC,OAAO,CAAC;IACxB,CAAC;IAED,MAAM,GAAiC,EAAE,CAAC;IAE1C,iBAAiB,CAAsD;IAEvE,YAAY,OAA0C;QAClD,IAAI,CAAC,OAAO,GAAG,EAAE,GAAG,oBAAoB,EAAE,GAAG,OAAO,EAAE,CAAC;IAC3D,CAAC;IAED;;OAEG;IACH,KAAK,CAQD,IAAW,EACX,UAAuB;QASvB,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YAC/B,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC;gBACpB,2BAA2B;gBAC3B,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;gBAChC,MAAM,IAAI,KAAK,CACX,+CAA+C,UAAU,GAAG,CAC/D,CAAC;YACN,CAAC;QACL,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC;QAEtC,MAAM,IAAI,GAAG,UAAU,CAAC,OAAO,EAAE,CAAC;QAClC,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC;QAEnB,oCAAoC;QACpC,OAAO,IAAa,CAAC;IACzB,CAAC;IAED;;;;OAIG;IACH,MAAM,CACF,KAAa;QAOb,IAAI,CAAC,CAAC,KAAK,YAAY,MAAM,CAAC,EAAE,CAAC;YAC7B,MAAM,IAAI,SAAS,CAAC,6CAA6C,CAAC,CAAC;QACvE,CAAC;QAED,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;YAChC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC7B,CAAC;QACD,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,KAAK,CAAC;QAC1B,MAAM,CAAC,gBAAgB,CACnB,IAAI,CAAC,MAAM,EACX,MAAM,CAAC,yBAAyB,CAAC,KAAK,CAAC,MAAM,CAAC,CACjD,CAAC;QACF,OAAO,IAAa,CAAC;IACzB,CAAC;IAED,OAAO,CAIL,IAAW,EAAE,IAAW,EAAE,cAAgC;QACxD,OAAO,IAAI,CAAC,KAAK,CACb,IAAI,EACJ,IAAI,qBAAqB,CAAC,IAAI,EAAE,cAAc,CAAC,CAClD,CAAC;IACN,CAAC;IAED;;OAEG;IACH,IAAI,CACA,IAAW,EACX,cAAgC;QAEhC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,kBAAkB,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;IACvE,CAAC;IAED;;OAEG;IACH,KAAK,CACD,IAAW,EACX,cAAgC;QAEhC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,kBAAkB,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC;IACxE,CAAC;IAED;;OAEG;IACH,KAAK,CACD,IAAW,EACX,cAAgC;QAEhC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,kBAAkB,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC;IACxE,CAAC;IAED;;OAEG;IACH,MAAM,CACF,IAAW,EACX,cAAgC;QAEhC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,kBAAkB,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IACzE,CAAC;IAED;;OAEG;IACH,KAAK,CACD,IAAW,EACX,cAAgC;QAEhC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,kBAAkB,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC;IACxE,CAAC;IAED;;OAEG;IACH,MAAM,CACF,IAAW,EACX,cAAgC;QAEhC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,kBAAkB,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IACzE,CAAC;IAED,OAAO,CAIL,IAAW,EAAE,IAAW,EAAE,cAAgC;QACxD,OAAO,IAAI,CAAC,KAAK,CACb,IAAI,EACJ,IAAI,qBAAqB,CAAC,IAAI,EAAE,cAAc,CAAC,CAClD,CAAC;IACN,CAAC;IAED;;;;OAIG;IACH,KAAK,CAGH,IAAW,EAAE,cAAgC;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,kBAAkB,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC;IACxE,CAAC;IAED;;;;OAIG;IACH,MAAM,CAGJ,IAAW,EAAE,cAAgC;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,kBAAkB,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IACzE,CAAC;IAED,gBAAgB,GAKZ,CACA,IAAiB,EACjB,IAA0B,EAC1B,OAE0C,EACrC,EAAE;QACP,IAAI,QAAQ,IAAI,OAAO,EAAE,CAAC;YACtB,OAAO,IAAI,CAAC,KAAK,CACb,IAAI,EACJ,IAAI,oCAAoC,CAAC,IAAI,EAAE,OAAO,CAAC,CACjD,CAAC;QACf,CAAC;aAAM,CAAC;YACJ,OAAO,IAAI,CAAC,KAAK,CACb,IAAI,EACJ,IAAI,uCAAuC,CAAC,IAAI,EAAE,OAAO,CAAC,CACpD,CAAC;QACf,CAAC;IACL,CAAC,CAAC;IAEF,UAAU,GAMN,CACA,IAAiB,EACjB,OAAgB,EAChB,cAAuB,EAClB,EAAE;QACP,OAAO,IAAI,CAAC,gBAAgB,CACxB,IAAI,EACJ,8BAA8B,CAAC,QAAQ,EACvC,OAAgB,EAChB,cAAc,CACR,CAAC;IACf,CAAC,CAAC;IAEF,MAAM,GAMF,CACA,IAAiB,EACjB,OAAgB,EAChB,cAAuB,EAClB,EAAE;QACP,OAAO,IAAI,CAAC,gBAAgB,CACxB,IAAI,EACJ,0BAA0B,CAAC,QAAQ,EACnC,OAAgB,EAChB,cAAc,CACR,CAAC;IACf,CAAC,CAAC;IAEF;;;;;;;;;OASG;IACH,KAAK,CAOD,KAA6D;QAE7D,MAAM,CAAC,gBAAgB,CACnB,IAAI,CAAC,MAAM,EACX,MAAM,CAAC,yBAAyB,CAAC,KAAK,CAAC,CAC1C,CAAC;QACF,OAAO,IAAa,CAAC;IACzB,CAAC;IA6BD,eAAe,CAAC,QAAmD;QAC/D,IAAI,CAAC,iBAAiB,GAAG,QAAQ,CAAC;QAClC,OAAO,IAAa,CAAC;IACzB,CAAC;IAWD,WAAW,CACP,MAA0C;QAI1C,MAAM,WAAW,GAAG,IAAI,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAEjD,IAAI,OAAO,GAAG,WAAW,CAAC,OAAO,EAAE,CAAC;QAEpC,MAAM,aAAa,GAAG,MAAM,CAAC,QAAQ,CAAC;QACtC,KAAK,MAAM,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YAC5C,OAAO,GAAG,OAAO;iBACZ,IAAI,CAAC,GAAG,EAAE,CACP,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC,CAC5D;iBACA,IAAI,CACD,CAAC,UAAU,EAAE,EAAE;gBACX,WAAW,CAAC,GAAG,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;YACtC,CAAC,EACD,CAAC,CAAC,EAAE,EAAE;gBACF,IAAI,CAAC,CAAC,CAAC,YAAY,uBAAuB,CAAC,EAAE,CAAC;oBAC1C,MAAM,CAAC,CAAC;gBACZ,CAAC;gBAED,IAAI,MAAM,CAAC,QAAQ,KAAK,aAAa,EAAE,CAAC;oBACpC,MAAM,IAAI,gBAAgB,EAAE,CAAC;gBACjC,CAAC;qBAAM,CAAC;oBACJ,MAAM,IAAI,wBAAwB,EAAE,CAAC;gBACzC,CAAC;YACL,CAAC,CACJ,CAAC;QACV,CAAC;QAED,OAAO,OAAO;aACT,IAAI,CAAC,GAAG,EAAE;YACP,MAAM,KAAK,GAAG,WAAW,CAAC,KAAK,CAAC;YAEhC,yBAAyB;YACzB,IAAI,IAAI,CAAC,iBAAiB,EAAE,CAAC;gBACzB,MAAM,QAAQ,GAAG,IAAI,CAAC,iBAAiB,CAAC,IAAI,CACxC,KAAc,EACd,KAAc,CACjB,CAAC;gBACF,gDAAgD;gBAChD,0DAA0D;gBAC1D,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;oBACzB,OAAO,QAAiB,CAAC;gBAC7B,CAAC;YACL,CAAC;YAED,OAAO,KAAc,CAAC;QAC1B,CAAC,CAAC;aACD,cAAc,EAAE,CAAC;IAC1B,CAAC;IAED;;;;;OAKG;IACH,SAAS,CACL,IAA2C,EAC3C,MAAmB;QAEnB,IAAI,WAAwB,CAAC;QAC7B,IAAI,iBAAiB,CAAC,IAAI,CAAC,EAAE,CAAC;YAC1B,WAAW,GAAG,IAAI,CAAC,mBAAmB,CAAC,CAAC;YACxC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC9C,MAAM,UAAU,GAAG,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;gBACxC,IAAI,UAAU,EAAE,CAAC;oBACb,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;gBAC1B,CAAC;YACL,CAAC;QACL,CAAC;aAAM,CAAC;YACJ,WAAW,GAAG,IAAI,WAAW,CAAC,EAAE,CAAC,CAAC;YAClC,KAAK,MAAM,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;gBAC5C,MAAM,UAAU,GAAG,UAAU,CAAC,MAAM,CAChC,IAAI,CAAC,OAAO,EACZ,WAAW,EACV,IAAqC,CAAC,IAAI,CAAC,CAC/C,CAAC;gBACF,WAAW,CAAC,GAAG,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;YACtC,CAAC;QACL,CAAC;QAED,IAAI,UAAU,GAAG,CAAC,CAAC;QACnB,MAAM,UAAU,GAGV,EAAE,CAAC;QAET,KAAK,MAAM,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YAChC,MAAM,UAAU,GAAG,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YACzC,MAAM,IAAI,GAAG,UAAU,CAAC,OAAO,EAAE,CAAC;YAClC,UAAU,CAAC,IAAI,CAAC,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC;YACtC,UAAU,IAAI,IAAI,CAAC;QACvB,CAAC;QAED,IAAI,CAAC,MAAM,EAAE,CAAC;YACV,MAAM,GAAG,IAAI,UAAU,CAAC,UAAU,CAAC,CAAC;QACxC,CAAC;aAAM,IAAI,MAAM,CAAC,MAAM,GAAG,UAAU,EAAE,CAAC;YACpC,MAAM,IAAI,SAAS,CAAC,4BAA4B,CAAC,CAAC;QACtD,CAAC;QAED,IAAI,MAAM,GAAG,CAAC,CAAC;QACf,KAAK,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,IAAI,UAAU,EAAE,CAAC;YAC5C,UAAU,CAAC,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;YACrC,MAAM,IAAI,IAAI,CAAC;QACnB,CAAC;QAED,IAAI,MAAM,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;YAC/B,OAAO,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,UAAU,CAAC,CAAC;QAC1C,CAAC;aAAM,CAAC;YACJ,OAAO,MAAM,CAAC;QAClB,CAAC;IACL,CAAC;CACJ"}

package/esm/sync-promise.d.ts

@@ -0,0 +1,13 @@
+export interface SyncPromise<T> {
+    then<TResult1 = T, TResult2 = never>(onfulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | null | undefined, onrejected?: ((reason: unknown) => TResult2 | PromiseLike<TResult2>) | null | undefined): SyncPromise<TResult1 | TResult2>;
+    valueOrPromise(): T | PromiseLike<T>;
+}
+interface SyncPromiseStatic {
+    reject<T = never>(reason?: unknown): SyncPromise<T>;
+    resolve(): SyncPromise<void>;
+    resolve<T>(value: T | PromiseLike<T>): SyncPromise<T>;
+    try<T>(executor: () => T | PromiseLike<T>): SyncPromise<T>;
+}
+export declare const SyncPromise: SyncPromiseStatic;
+export {};
+//# sourceMappingURL=sync-promise.d.ts.map

package/esm/sync-promise.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sync-promise.d.ts","sourceRoot":"","sources":["../src/sync-promise.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,WAAW,CAAC,CAAC;IAC1B,IAAI,CAAC,QAAQ,GAAG,CAAC,EAAE,QAAQ,GAAG,KAAK,EAC/B,WAAW,CAAC,EACN,CAAC,CAAC,KAAK,EAAE,CAAC,KAAK,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC,GAChD,IAAI,GACJ,SAAS,EACf,UAAU,CAAC,EACL,CAAC,CAAC,MAAM,EAAE,OAAO,KAAK,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC,GACvD,IAAI,GACJ,SAAS,GAChB,WAAW,CAAC,QAAQ,GAAG,QAAQ,CAAC,CAAC;IAEpC,cAAc,IAAI,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;CACxC;AAED,UAAU,iBAAiB;IACvB,MAAM,CAAC,CAAC,GAAG,KAAK,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;IAEpD,OAAO,IAAI,WAAW,CAAC,IAAI,CAAC,CAAC;IAC7B,OAAO,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;IAEtD,GAAG,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;CAC9D;AAED,eAAO,MAAM,WAAW,EAAE,iBA8BzB,CAAC"}

package/esm/sync-promise.js

@@ -0,0 +1,71 @@
+export const SyncPromise = {
+    reject(reason) {
+        return new RejectedSyncPromise(reason);
+    },
+    resolve(value) {
+        if (typeof value === "object" &&
+            value !== null &&
+            typeof value.then === "function") {
+            if (value instanceof PendingSyncPromise ||
+                value instanceof ResolvedSyncPromise ||
+                value instanceof RejectedSyncPromise) {
+                return value;
+            }
+            return new PendingSyncPromise(value);
+        }
+        else {
+            return new ResolvedSyncPromise(value);
+        }
+    },
+    try(executor) {
+        try {
+            return SyncPromise.resolve(executor());
+        }
+        catch (e) {
+            return SyncPromise.reject(e);
+        }
+    },
+};
+class PendingSyncPromise {
+    #promise;
+    constructor(promise) {
+        this.#promise = promise;
+    }
+    then(onfulfilled, onrejected) {
+        return new PendingSyncPromise(this.#promise.then(onfulfilled, onrejected));
+    }
+    valueOrPromise() {
+        return this.#promise;
+    }
+}
+class ResolvedSyncPromise {
+    #value;
+    constructor(value) {
+        this.#value = value;
+    }
+    then(onfulfilled) {
+        if (!onfulfilled) {
+            return this;
+        }
+        return SyncPromise.try(() => onfulfilled(this.#value));
+    }
+    valueOrPromise() {
+        return this.#value;
+    }
+}
+class RejectedSyncPromise {
+    #reason;
+    constructor(reason) {
+        this.#reason = reason;
+    }
+    then(_, onrejected) {
+        if (!onrejected) {
+            return this;
+        }
+        return SyncPromise.try(() => onrejected(this.#reason));
+    }
+    valueOrPromise() {
+        throw this.#reason;
+    }
+}
+//# sourceMappingURL=sync-promise.js.map

package/esm/sync-promise.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sync-promise.js","sourceRoot":"","sources":["../src/sync-promise.ts"],"names":[],"mappings":"AAwBA,MAAM,CAAC,MAAM,WAAW,GAAsB;IAC1C,MAAM,CAAY,MAAgB;QAC9B,OAAO,IAAI,mBAAmB,CAAC,MAAM,CAAC,CAAC;IAC3C,CAAC;IACD,OAAO,CAAI,KAA0B;QACjC,IACI,OAAO,KAAK,KAAK,QAAQ;YACzB,KAAK,KAAK,IAAI;YACd,OAAQ,KAAwB,CAAC,IAAI,KAAK,UAAU,EACtD,CAAC;YACC,IACI,KAAK,YAAY,kBAAkB;gBACnC,KAAK,YAAY,mBAAmB;gBACpC,KAAK,YAAY,mBAAmB,EACtC,CAAC;gBACC,OAAO,KAAK,CAAC;YACjB,CAAC;YAED,OAAO,IAAI,kBAAkB,CAAC,KAAuB,CAAC,CAAC;QAC3D,CAAC;aAAM,CAAC;YACJ,OAAO,IAAI,mBAAmB,CAAC,KAAU,CAAC,CAAC;QAC/C,CAAC;IACL,CAAC;IACD,GAAG,CAAI,QAAkC;QACrC,IAAI,CAAC;YACD,OAAO,WAAW,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;QAC3C,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACT,OAAO,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QACjC,CAAC;IACL,CAAC;CACJ,CAAC;AAEF,MAAM,kBAAkB;IACpB,QAAQ,CAAiB;IAEzB,YAAY,OAAuB;QAC/B,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;IAC5B,CAAC;IAED,IAAI,CACA,WAGe,EACf,UAGe;QAEf,OAAO,IAAI,kBAAkB,CACzB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC,CAC9C,CAAC;IACN,CAAC;IAED,cAAc;QACV,OAAO,IAAI,CAAC,QAAQ,CAAC;IACzB,CAAC;CACJ;AAED,MAAM,mBAAmB;IACrB,MAAM,CAAI;IAEV,YAAY,KAAQ;QAChB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACxB,CAAC;IAED,IAAI,CACA,WAGe;QAEf,IAAI,CAAC,WAAW,EAAE,CAAC;YACf,OAAO,IAAa,CAAC;QACzB,CAAC;QACD,OAAO,WAAW,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IAC3D,CAAC;IAED,cAAc;QACV,OAAO,IAAI,CAAC,MAAM,CAAC;IACvB,CAAC;CACJ;AAED,MAAM,mBAAmB;IACrB,OAAO,CAAU;IAEjB,YAAY,MAAe;QACvB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IAC1B,CAAC;IAED,IAAI,CACA,CAAuE,EACvE,UAGe;QAEf,IAAI,CAAC,UAAU,EAAE,CAAC;YACd,OAAO,IAAa,CAAC;QACzB,CAAC;QACD,OAAO,WAAW,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IAC3D,CAAC;IAED,cAAc;QACV,MAAM,IAAI,CAAC,OAAO,CAAC;IACvB,CAAC;CACJ"}

package/esm/types/bigint.d.ts

@@ -0,0 +1,25 @@
+import type { AsyncExactReadable, ExactReadable, StructOptions, StructValue } from "../basic/index.js";
+import { StructFieldDefinition, StructFieldValue } from "../basic/index.js";
+export type BigIntDeserializer = (array: Uint8Array, byteOffset: number, littleEndian: boolean) => bigint;
+export type BigIntSerializer = (array: Uint8Array, byteOffset: number, value: bigint, littleEndian: boolean) => void;
+export declare class BigIntFieldVariant {
+    readonly TTypeScriptType: bigint;
+    readonly size: number;
+    readonly deserialize: BigIntDeserializer;
+    readonly serialize: BigIntSerializer;
+    constructor(size: number, deserialize: BigIntDeserializer, serialize: BigIntSerializer);
+    static readonly Int64: BigIntFieldVariant;
+    static readonly Uint64: BigIntFieldVariant;
+}
+export declare class BigIntFieldDefinition<TVariant extends BigIntFieldVariant = BigIntFieldVariant, TTypeScriptType = TVariant["TTypeScriptType"]> extends StructFieldDefinition<void, TTypeScriptType> {
+    readonly variant: TVariant;
+    constructor(variant: TVariant, typescriptType?: TTypeScriptType);
+    getSize(): number;
+    create(options: Readonly<StructOptions>, struct: StructValue, value: TTypeScriptType): BigIntFieldValue<this>;
+    deserialize(options: Readonly<StructOptions>, stream: ExactReadable, struct: StructValue): BigIntFieldValue<this>;
+    deserialize(options: Readonly<StructOptions>, stream: AsyncExactReadable, struct: StructValue): Promise<BigIntFieldValue<this>>;
+}
+export declare class BigIntFieldValue<TDefinition extends BigIntFieldDefinition<BigIntFieldVariant, unknown>> extends StructFieldValue<TDefinition> {
+    serialize(array: Uint8Array, offset: number): void;
+}
+//# sourceMappingURL=bigint.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"bigint.d.ts","sourceRoot":"","sources":["../../src/types/bigint.ts"],"names":[],"mappings":"AAOA,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,MAAM,kBAAkB,GAAG,CAC7B,KAAK,EAAE,UAAU,EACjB,UAAU,EAAE,MAAM,EAClB,YAAY,EAAE,OAAO,KACpB,MAAM,CAAC;AAEZ,MAAM,MAAM,gBAAgB,GAAG,CAC3B,KAAK,EAAE,UAAU,EACjB,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,MAAM,EACb,YAAY,EAAE,OAAO,KACpB,IAAI,CAAC;AAEV,qBAAa,kBAAkB;IAC3B,QAAQ,CAAC,eAAe,EAAG,MAAM,CAAC;IAElC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB,QAAQ,CAAC,WAAW,EAAE,kBAAkB,CAAC;IAEzC,QAAQ,CAAC,SAAS,EAAE,gBAAgB,CAAC;gBAGjC,IAAI,EAAE,MAAM,EACZ,WAAW,EAAE,kBAAkB,EAC/B,SAAS,EAAE,gBAAgB;IAO/B,MAAM,CAAC,QAAQ,CAAC,KAAK,qBAAiD;IAEtE,MAAM,CAAC,QAAQ,CAAC,MAAM,qBAAmD;CAC5E;AAED,qBAAa,qBAAqB,CAC9B,QAAQ,SAAS,kBAAkB,GAAG,kBAAkB,EACxD,eAAe,GAAG,QAAQ,CAAC,iBAAiB,CAAC,CAC/C,SAAQ,qBAAqB,CAAC,IAAI,EAAE,eAAe,CAAC;IAClD,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC;gBAEf,OAAO,EAAE,QAAQ,EAAE,cAAc,CAAC,EAAE,eAAe;IAM/D,OAAO,IAAI,MAAM;IAIjB,MAAM,CACF,OAAO,EAAE,QAAQ,CAAC,aAAa,CAAC,EAChC,MAAM,EAAE,WAAW,EACnB,KAAK,EAAE,eAAe,GACvB,gBAAgB,CAAC,IAAI,CAAC;IAIhB,WAAW,CAChB,OAAO,EAAE,QAAQ,CAAC,aAAa,CAAC,EAChC,MAAM,EAAE,aAAa,EACrB,MAAM,EAAE,WAAW,GACpB,gBAAgB,CAAC,IAAI,CAAC;IAChB,WAAW,CAChB,OAAO,EAAE,QAAQ,CAAC,aAAa,CAAC,EAChC,MAAM,EAAE,kBAAkB,EAC1B,MAAM,EAAE,WAAW,GACpB,OAAO,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;CAmBrC;AAED,qBAAa,gBAAgB,CACzB,WAAW,SAAS,qBAAqB,CAAC,kBAAkB,EAAE,OAAO,CAAC,CACxE,SAAQ,gBAAgB,CAAC,WAAW,CAAC;IAC1B,SAAS,CAAC,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI;CAQ9D"}

package/esm/types/bigint.js

@@ -0,0 +1,46 @@
+import { getInt64, getUint64, setInt64, setUint64, } from "@yume-chan/no-data-view";
+import { StructFieldDefinition, StructFieldValue } from "../basic/index.js";
+import { SyncPromise } from "../sync-promise.js";
+export class BigIntFieldVariant {
+    TTypeScriptType;
+    size;
+    deserialize;
+    serialize;
+    constructor(size, deserialize, serialize) {
+        this.size = size;
+        this.deserialize = deserialize;
+        this.serialize = serialize;
+    }
+    static Int64 = new BigIntFieldVariant(8, getInt64, setInt64);
+    static Uint64 = new BigIntFieldVariant(8, getUint64, setUint64);
+}
+export class BigIntFieldDefinition extends StructFieldDefinition {
+    variant;
+    constructor(variant, typescriptType) {
+        void typescriptType;
+        super();
+        this.variant = variant;
+    }
+    getSize() {
+        return this.variant.size;
+    }
+    create(options, struct, value) {
+        return new BigIntFieldValue(this, options, struct, value);
+    }
+    deserialize(options, stream, struct) {
+        return SyncPromise.try(() => {
+            return stream.readExactly(this.getSize());
+        })
+            .then((array) => {
+            const value = this.variant.deserialize(array, 0, options.littleEndian);
+            return this.create(options, struct, value);
+        })
+            .valueOrPromise();
+    }
+}
+export class BigIntFieldValue extends StructFieldValue {
+    serialize(array, offset) {
+        this.definition.variant.serialize(array, offset, this.value, this.options.littleEndian);
+    }
+}
+//# sourceMappingURL=bigint.js.map

package/esm/types/bigint.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bigint.js","sourceRoot":"","sources":["../../src/types/bigint.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,QAAQ,EACR,SAAS,EACT,QAAQ,EACR,SAAS,GACZ,MAAM,yBAAyB,CAAC;AAQjC,OAAO,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAC5E,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAgBjD,MAAM,OAAO,kBAAkB;IAClB,eAAe,CAAU;IAEzB,IAAI,CAAS;IAEb,WAAW,CAAqB;IAEhC,SAAS,CAAmB;IAErC,YACI,IAAY,EACZ,WAA+B,EAC/B,SAA2B;QAE3B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC/B,CAAC;IAED,MAAM,CAAU,KAAK,GAAG,IAAI,kBAAkB,CAAC,CAAC,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;IAEtE,MAAM,CAAU,MAAM,GAAG,IAAI,kBAAkB,CAAC,CAAC,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;;AAG7E,MAAM,OAAO,qBAGX,SAAQ,qBAA4C;IACzC,OAAO,CAAW;IAE3B,YAAY,OAAiB,EAAE,cAAgC;QAC3D,KAAK,cAAc,CAAC;QACpB,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IAC3B,CAAC;IAED,OAAO;QACH,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;IAC7B,CAAC;IAED,MAAM,CACF,OAAgC,EAChC,MAAmB,EACnB,KAAsB;QAEtB,OAAO,IAAI,gBAAgB,CAAC,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;IAC9D,CAAC;IAYQ,WAAW,CAChB,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,OAAO,CAAC,WAAW,CAClC,KAAK,EACL,CAAC,EACD,OAAO,CAAC,YAAY,CACvB,CAAC;YACF,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,KAAc,CAAC,CAAC;QACxD,CAAC,CAAC;aACD,cAAc,EAAE,CAAC;IAC1B,CAAC;CACJ;AAED,MAAM,OAAO,gBAEX,SAAQ,gBAA6B;IAC1B,SAAS,CAAC,KAAiB,EAAE,MAAc;QAChD,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,SAAS,CAC7B,KAAK,EACL,MAAM,EACN,IAAI,CAAC,KAAc,EACnB,IAAI,CAAC,OAAO,CAAC,YAAY,CAC5B,CAAC;IACN,CAAC;CACJ"}

package/esm/types/buffer/base.d.ts

@@ -0,0 +1,69 @@
+import type { AsyncExactReadable, ExactReadable, StructOptions, StructValue } from "../../basic/index.js";
+import { StructFieldDefinition, StructFieldValue } from "../../basic/index.js";
+/**
+ * A converter for buffer-like fields.
+ * It converts `Uint8Array`s to custom-typed values when deserializing,
+ * and convert values back to `Uint8Array`s when serializing.
+ *
+ * @template TValue The type of the value that the converter converts to/from `Uint8Array`.
+ * @template TTypeScriptType Optionally another type to refine `TValue`.
+ * For example, `TValue` is `string`, and `TTypeScriptType` is `"foo" | "bar"`.
+ * `TValue` is specified by the developer when creating an converter implementation,
+ * `TTypeScriptType` is specified by the user when creating a field.
+ */
+export declare abstract class BufferFieldConverter<TValue = unknown, TTypeScriptType = TValue> {
+    readonly TTypeScriptType: TTypeScriptType;
+    /**
+     * When implemented in derived classes, converts the custom `value` to an `Uint8Array`
+     *
+     * This function should be "pure", i.e.,
+     * same `value` should always be converted to `Uint8Array`s that have same content.
+     */
+    abstract toBuffer(value: TValue): Uint8Array;
+    /** When implemented in derived classes, converts the `Uint8Array` to a custom value */
+    abstract toValue(array: Uint8Array): TValue;
+    /**
+     * When implemented in derived classes, gets the size in byte of the custom `value`.
+     *
+     * If the size can't be determined without first converting the `value` back to an `Uint8Array`,
+     * the implementer should return `undefined`. In which case, the caller will call `toBuffer` to
+     * convert the value to a `Uint8Array`, then read the length of the `Uint8Array`. The caller can
+     * cache the result so the serialization process doesn't need to call `toBuffer` again.
+     */
+    abstract getSize(value: TValue): number | undefined;
+}
+/** An identity converter, doesn't convert to anything else. */
+export declare class Uint8ArrayBufferFieldConverter<TTypeScriptType = Uint8Array> extends BufferFieldConverter<Uint8Array, TTypeScriptType> {
+    static readonly Instance: Uint8ArrayBufferFieldConverter<Uint8Array>;
+    protected constructor();
+    toBuffer(value: Uint8Array): Uint8Array;
+    toValue(buffer: Uint8Array): Uint8Array;
+    getSize(value: Uint8Array): number;
+}
+/** An `BufferFieldSubType` that converts between `Uint8Array` and `string` */
+export declare class StringBufferFieldConverter<TTypeScriptType = string> extends BufferFieldConverter<string, TTypeScriptType> {
+    static readonly Instance: StringBufferFieldConverter<string>;
+    toBuffer(value: string): Uint8Array;
+    toValue(array: Uint8Array): string;
+    getSize(): number | undefined;
+}
+export declare const EMPTY_UINT8_ARRAY: Uint8Array;
+export declare abstract class BufferLikeFieldDefinition<TConverter extends BufferFieldConverter<unknown, unknown> = BufferFieldConverter<unknown, unknown>, TOptions = void, TOmitInitKey extends PropertyKey = never, TTypeScriptType = TConverter["TTypeScriptType"]> extends StructFieldDefinition<TOptions, TTypeScriptType, TOmitInitKey> {
+    readonly converter: TConverter;
+    readonly TTypeScriptType: TTypeScriptType;
+    constructor(converter: TConverter, options: TOptions);
+    protected getDeserializeSize(struct: StructValue): number;
+    /**
+     * When implemented in derived classes, creates a `StructFieldValue` for the current field definition.
+     */
+    create(options: Readonly<StructOptions>, struct: StructValue, value: TTypeScriptType, array?: Uint8Array): BufferLikeFieldValue<this>;
+    deserialize(options: Readonly<StructOptions>, stream: ExactReadable, struct: StructValue): BufferLikeFieldValue<this>;
+    deserialize(options: Readonly<StructOptions>, stream: AsyncExactReadable, struct: StructValue): Promise<BufferLikeFieldValue<this>>;
+}
+export declare class BufferLikeFieldValue<TDefinition extends BufferLikeFieldDefinition<BufferFieldConverter<unknown, unknown>, any, any, any>> extends StructFieldValue<TDefinition> {
+    protected array: Uint8Array | undefined;
+    constructor(definition: TDefinition, options: Readonly<StructOptions>, struct: StructValue, value: TDefinition["TTypeScriptType"], array?: Uint8Array);
+    set(value: TDefinition["TValue"]): void;
+    serialize(array: Uint8Array, offset: number): void;
+}
+//# sourceMappingURL=base.d.ts.map

package/esm/types/buffer/base.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../../src/types/buffer/base.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACR,kBAAkB,EAClB,aAAa,EACb,aAAa,EACb,WAAW,EACd,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAK/E;;;;;;;;;;GAUG;AACH,8BAAsB,oBAAoB,CACtC,MAAM,GAAG,OAAO,EAChB,eAAe,GAAG,MAAM;IAExB,QAAQ,CAAC,eAAe,EAAG,eAAe,CAAC;IAE3C;;;;;OAKG;IACH,QAAQ,CAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,UAAU;IAE5C,uFAAuF;IACvF,QAAQ,CAAC,OAAO,CAAC,KAAK,EAAE,UAAU,GAAG,MAAM;IAE3C;;;;;;;OAOG;IACH,QAAQ,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;CACtD;AAED,+DAA+D;AAC/D,qBAAa,8BAA8B,CACvC,eAAe,GAAG,UAAU,CAC9B,SAAQ,oBAAoB,CAAC,UAAU,EAAE,eAAe,CAAC;IACvD,MAAM,CAAC,QAAQ,CAAC,QAAQ,6CAAwC;IAEhE,SAAS;IAIA,QAAQ,CAAC,KAAK,EAAE,UAAU,GAAG,UAAU;IAIvC,OAAO,CAAC,MAAM,EAAE,UAAU,GAAG,UAAU;IAIvC,OAAO,CAAC,KAAK,EAAE,UAAU,GAAG,MAAM;CAG9C;AAED,8EAA8E;AAC9E,qBAAa,0BAA0B,CACnC,eAAe,GAAG,MAAM,CAC1B,SAAQ,oBAAoB,CAAC,MAAM,EAAE,eAAe,CAAC;IACnD,MAAM,CAAC,QAAQ,CAAC,QAAQ,qCAAoC;IAEnD,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,UAAU;IAInC,OAAO,CAAC,KAAK,EAAE,UAAU,GAAG,MAAM;IAIlC,OAAO,IAAI,MAAM,GAAG,SAAS;CAIzC;AAED,eAAO,MAAM,iBAAiB,YAAoB,CAAC;AAEnD,8BAAsB,yBAAyB,CAC3C,UAAU,SAAS,oBAAoB,CACnC,OAAO,EACP,OAAO,CACV,GAAG,oBAAoB,CAAC,OAAO,EAAE,OAAO,CAAC,EAC1C,QAAQ,GAAG,IAAI,EACf,YAAY,SAAS,WAAW,GAAG,KAAK,EACxC,eAAe,GAAG,UAAU,CAAC,iBAAiB,CAAC,CACjD,SAAQ,qBAAqB,CAAC,QAAQ,EAAE,eAAe,EAAE,YAAY,CAAC;IACpE,QAAQ,CAAC,SAAS,EAAE,UAAU,CAAC;IAC/B,QAAQ,CAAC,eAAe,EAAG,eAAe,CAAC;gBAE/B,SAAS,EAAE,UAAU,EAAE,OAAO,EAAE,QAAQ;IAKpD,SAAS,CAAC,kBAAkB,CAAC,MAAM,EAAE,WAAW,GAAG,MAAM;IAKzD;;OAEG;IACH,MAAM,CACF,OAAO,EAAE,QAAQ,CAAC,aAAa,CAAC,EAChC,MAAM,EAAE,WAAW,EACnB,KAAK,EAAE,eAAe,EACtB,KAAK,CAAC,EAAE,UAAU,GACnB,oBAAoB,CAAC,IAAI,CAAC;IAIpB,WAAW,CAChB,OAAO,EAAE,QAAQ,CAAC,aAAa,CAAC,EAChC,MAAM,EAAE,aAAa,EACrB,MAAM,EAAE,WAAW,GACpB,oBAAoB,CAAC,IAAI,CAAC;IACpB,WAAW,CAChB,OAAO,EAAE,QAAQ,CAAC,aAAa,CAAC,EAChC,MAAM,EAAE,kBAAkB,EAC1B,MAAM,EAAE,WAAW,GACpB,OAAO,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;CAoBzC;AAED,qBAAa,oBAAoB,CAC7B,WAAW,SAAS,yBAAyB,CACzC,oBAAoB,CAAC,OAAO,EAAE,OAAO,CAAC,EACtC,GAAG,EACH,GAAG,EACH,GAAG,CACN,CACH,SAAQ,gBAAgB,CAAC,WAAW,CAAC;IACnC,SAAS,CAAC,KAAK,EAAE,UAAU,GAAG,SAAS,CAAC;gBAIpC,UAAU,EAAE,WAAW,EACvB,OAAO,EAAE,QAAQ,CAAC,aAAa,CAAC,EAChC,MAAM,EAAE,WAAW,EACnB,KAAK,EAAE,WAAW,CAAC,iBAAiB,CAAC,EACrC,KAAK,CAAC,EAAE,UAAU;IAMb,GAAG,CAAC,KAAK,EAAE,WAAW,CAAC,QAAQ,CAAC,GAAG,IAAI;IAOvC,SAAS,CAAC,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI;CAI9D"}

package/esm/types/buffer/base.js

@@ -0,0 +1,101 @@
+import { StructFieldDefinition, StructFieldValue } from "../../basic/index.js";
+import { SyncPromise } from "../../sync-promise.js";
+import { decodeUtf8, encodeUtf8 } from "../../utils.js";
+/**
+ * A converter for buffer-like fields.
+ * It converts `Uint8Array`s to custom-typed values when deserializing,
+ * and convert values back to `Uint8Array`s when serializing.
+ *
+ * @template TValue The type of the value that the converter converts to/from `Uint8Array`.
+ * @template TTypeScriptType Optionally another type to refine `TValue`.
+ * For example, `TValue` is `string`, and `TTypeScriptType` is `"foo" | "bar"`.
+ * `TValue` is specified by the developer when creating an converter implementation,
+ * `TTypeScriptType` is specified by the user when creating a field.
+ */
+export class BufferFieldConverter {
+    TTypeScriptType;
+}
+/** An identity converter, doesn't convert to anything else. */
+export class Uint8ArrayBufferFieldConverter extends BufferFieldConverter {
+    static Instance = new Uint8ArrayBufferFieldConverter();
+    constructor() {
+        super();
+    }
+    toBuffer(value) {
+        return value;
+    }
+    toValue(buffer) {
+        return buffer;
+    }
+    getSize(value) {
+        return value.length;
+    }
+}
+/** An `BufferFieldSubType` that converts between `Uint8Array` and `string` */
+export class StringBufferFieldConverter extends BufferFieldConverter {
+    static Instance = new StringBufferFieldConverter();
+    toBuffer(value) {
+        return encodeUtf8(value);
+    }
+    toValue(array) {
+        return decodeUtf8(array);
+    }
+    getSize() {
+        // See the note in `BufferFieldConverter.getSize`
+        return undefined;
+    }
+}
+export const EMPTY_UINT8_ARRAY = new Uint8Array(0);
+export class BufferLikeFieldDefinition extends StructFieldDefinition {
+    converter;
+    TTypeScriptType;
+    constructor(converter, options) {
+        super(options);
+        this.converter = converter;
+    }
+    getDeserializeSize(struct) {
+        void struct;
+        return this.getSize();
+    }
+    /**
+     * When implemented in derived classes, creates a `StructFieldValue` for the current field definition.
+     */
+    create(options, struct, value, array) {
+        return new BufferLikeFieldValue(this, options, struct, value, array);
+    }
+    deserialize(options, stream, struct) {
+        return SyncPromise.try(() => {
+            const size = this.getDeserializeSize(struct);
+            if (size === 0) {
+                return EMPTY_UINT8_ARRAY;
+            }
+            else {
+                return stream.readExactly(size);
+            }
+        })
+            .then((array) => {
+            const value = this.converter.toValue(array);
+            return this.create(options, struct, value, array);
+        })
+            .valueOrPromise();
+    }
+}
+export class BufferLikeFieldValue extends StructFieldValue {
+    array;
+    // eslint-disable-next-line @typescript-eslint/max-params
+    constructor(definition, options, struct, value, array) {
+        super(definition, options, struct, value);
+        this.array = array;
+    }
+    set(value) {
+        super.set(value);
+        // When value changes, clear the cached `array`
+        // It will be lazily calculated in `serialize()`
+        this.array = undefined;
+    }
+    serialize(array, offset) {
+        this.array ??= this.definition.converter.toBuffer(this.value);
+        array.set(this.array, offset);
+    }
+}
+//# sourceMappingURL=base.js.map

package/esm/types/buffer/base.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.js","sourceRoot":"","sources":["../../../src/types/buffer/base.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAC/E,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAEpD,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAExD;;;;;;;;;;GAUG;AACH,MAAM,OAAgB,oBAAoB;IAI7B,eAAe,CAAmB;CAsB9C;AAED,+DAA+D;AAC/D,MAAM,OAAO,8BAEX,SAAQ,oBAAiD;IACvD,MAAM,CAAU,QAAQ,GAAG,IAAI,8BAA8B,EAAE,CAAC;IAEhE;QACI,KAAK,EAAE,CAAC;IACZ,CAAC;IAEQ,QAAQ,CAAC,KAAiB;QAC/B,OAAO,KAAK,CAAC;IACjB,CAAC;IAEQ,OAAO,CAAC,MAAkB;QAC/B,OAAO,MAAM,CAAC;IAClB,CAAC;IAEQ,OAAO,CAAC,KAAiB;QAC9B,OAAO,KAAK,CAAC,MAAM,CAAC;IACxB,CAAC;;AAGL,8EAA8E;AAC9E,MAAM,OAAO,0BAEX,SAAQ,oBAA6C;IACnD,MAAM,CAAU,QAAQ,GAAG,IAAI,0BAA0B,EAAE,CAAC;IAEnD,QAAQ,CAAC,KAAa;QAC3B,OAAO,UAAU,CAAC,KAAK,CAAC,CAAC;IAC7B,CAAC;IAEQ,OAAO,CAAC,KAAiB;QAC9B,OAAO,UAAU,CAAC,KAAK,CAAC,CAAC;IAC7B,CAAC;IAEQ,OAAO;QACZ,iDAAiD;QACjD,OAAO,SAAS,CAAC;IACrB,CAAC;;AAGL,MAAM,CAAC,MAAM,iBAAiB,GAAG,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC;AAEnD,MAAM,OAAgB,yBAQpB,SAAQ,qBAA8D;IAC3D,SAAS,CAAa;IACtB,eAAe,CAAmB;IAE3C,YAAY,SAAqB,EAAE,OAAiB;QAChD,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC/B,CAAC;IAES,kBAAkB,CAAC,MAAmB;QAC5C,KAAK,MAAM,CAAC;QACZ,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC;IAC1B,CAAC;IAED;;OAEG;IACH,MAAM,CACF,OAAgC,EAChC,MAAmB,EACnB,KAAsB,EACtB,KAAkB;QAElB,OAAO,IAAI,oBAAoB,CAAC,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;IACzE,CAAC;IAYQ,WAAW,CAChB,OAAgC,EAChC,MAA0C,EAC1C,MAAmB;QAEnB,OAAO,WAAW,CAAC,GAAG,CAAC,GAAG,EAAE;YACxB,MAAM,IAAI,GAAG,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;YAC7C,IAAI,IAAI,KAAK,CAAC,EAAE,CAAC;gBACb,OAAO,iBAAiB,CAAC;YAC7B,CAAC;iBAAM,CAAC;gBACJ,OAAO,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;YACpC,CAAC;QACL,CAAC,CAAC;aACG,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE;YACZ,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,CAAoB,CAAC;YAC/D,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;QACtD,CAAC,CAAC;aACD,cAAc,EAAE,CAAC;IAC1B,CAAC;CACJ;AAED,MAAM,OAAO,oBAOX,SAAQ,gBAA6B;IACzB,KAAK,CAAyB;IAExC,yDAAyD;IACzD,YACI,UAAuB,EACvB,OAAgC,EAChC,MAAmB,EACnB,KAAqC,EACrC,KAAkB;QAElB,KAAK,CAAC,UAAU,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;QAC1C,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACvB,CAAC;IAEQ,GAAG,CAAC,KAA4B;QACrC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACjB,+CAA+C;QAC/C,gDAAgD;QAChD,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;IAC3B,CAAC;IAEQ,SAAS,CAAC,KAAiB,EAAE,MAAc;QAChD,IAAI,CAAC,KAAK,KAAK,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC9D,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IAClC,CAAC;CACJ"}

package/esm/types/buffer/fixed-length.d.ts

@@ -0,0 +1,9 @@
+import type { BufferFieldConverter } from "./base.js";
+import { BufferLikeFieldDefinition } from "./base.js";
+export interface FixedLengthBufferLikeFieldOptions {
+    length: number;
+}
+export declare class FixedLengthBufferLikeFieldDefinition<TConverter extends BufferFieldConverter = BufferFieldConverter, TOptions extends FixedLengthBufferLikeFieldOptions = FixedLengthBufferLikeFieldOptions, TTypeScriptType = TConverter["TTypeScriptType"]> extends BufferLikeFieldDefinition<TConverter, TOptions, never, TTypeScriptType> {
+    getSize(): number;
+}
+//# sourceMappingURL=fixed-length.d.ts.map

package/esm/types/buffer/fixed-length.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fixed-length.d.ts","sourceRoot":"","sources":["../../../src/types/buffer/fixed-length.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,WAAW,CAAC;AACtD,OAAO,EAAE,yBAAyB,EAAE,MAAM,WAAW,CAAC;AAEtD,MAAM,WAAW,iCAAiC;IAC9C,MAAM,EAAE,MAAM,CAAC;CAClB;AAED,qBAAa,oCAAoC,CAC7C,UAAU,SAAS,oBAAoB,GAAG,oBAAoB,EAC9D,QAAQ,SACJ,iCAAiC,GAAG,iCAAiC,EACzE,eAAe,GAAG,UAAU,CAAC,iBAAiB,CAAC,CACjD,SAAQ,yBAAyB,CAC/B,UAAU,EACV,QAAQ,EACR,KAAK,EACL,eAAe,CAClB;IACG,OAAO,IAAI,MAAM;CAGpB"}

package/esm/types/buffer/fixed-length.js

@@ -0,0 +1,7 @@
+import { BufferLikeFieldDefinition } from "./base.js";
+export class FixedLengthBufferLikeFieldDefinition extends BufferLikeFieldDefinition {
+    getSize() {
+        return this.options.length;
+    }
+}
+//# sourceMappingURL=fixed-length.js.map