ya-webadb/libraries/struct/src/basic/field-value.ts

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.
 *
 * It may contains extra metadata about the value which are essential or
 * helpful for the serialization process.
 */
export abstract class StructFieldValue<
    TDefinition extends StructFieldDefinition<unknown, unknown, PropertyKey>,
> {
    /** Gets the definition associated with this runtime value */
    readonly definition: TDefinition;

    /** Gets the options of the associated `Struct` */
    readonly options: Readonly<StructOptions>;

    /** Gets the associated `Struct` instance */
    readonly struct: StructValue;

    get hasCustomAccessors(): boolean {
        return (
            this.get !== StructFieldValue.prototype.get ||
            this.set !== StructFieldValue.prototype.set
        );
    }

    protected value: TDefinition["TValue"];

    constructor(
        definition: TDefinition,
        options: Readonly<StructOptions>,
        struct: StructValue,
        value: TDefinition["TValue"],
    ) {
        this.definition = definition;
        this.options = options;
        this.struct = struct;
        this.value = value;
    }

    /**
     * Gets size of this field. By default, it returns its `definition`'s size.
     *
     * When overridden in derived classes, can have custom logic to calculate the actual size.
     */
    getSize(): number {
        return this.definition.getSize();
    }

    /**
     * When implemented in derived classes, reads current field's value.
     */
    get(): TDefinition["TValue"] {
        return this.value as never;
    }

    /**
     * When implemented in derived classes, updates current field's value.
     */
    set(value: TDefinition["TValue"]): void {
        this.value = value;
    }

    /**
     * When implemented in derived classes, serializes this field into `array` at `offset`
     */
    abstract serialize(array: Uint8Array, offset: number): void;
}