Class StorageLayout<Schema>

constructor

• new StorageLayout<
      Schema extends
          Readonly<Record<string, StorageType>> = Readonly<
          Record<string, StorageType>,
      >,
  >(
      schema: Schema,
  ): StorageLayout<Schema>

  Compile and snapshot one ordered storage schema.

  Type Parameters

  • Schema extends Readonly<Record<string, StorageType>> = Readonly<Record<string, StorageType>>

  Parameters

  • schema: Schema

  Returns StorageLayout<Schema>

Readonlyalignment

ReadonlybyteLength

Readonlyfields

Readonlyschema

createBuffer

• createBuffer(values?: Partial<StorageValues<Schema>>): ArrayBuffer

  Allocate a zero-filled structure and optionally pack a subset of fields.

  Parameters

  • values: Partial<StorageValues<Schema>> = {}

  Returns ArrayBuffer

write

• write<Name extends string>(
      target: ArrayBuffer,
      name: Name,
      value: StorageValue<Schema[Name]>,
  ): StorageWriteResult

  Pack one top-level field and return the changed byte span.

  Type Parameters

  • Name extends string

  Parameters

  • target: ArrayBuffer
  • name: Name
  • value: StorageValue<Schema[Name]>

  Returns StorageWriteResult

writeInto

• writeInto<Name extends string>(
      target: ArrayBuffer,
      name: Name,
      value: StorageValue<Schema[Name]>,
      result: StorageWriteResult,
  ): StorageWriteResult

  Pack one field into caller-owned result storage to avoid a result allocation.

  Type Parameters

  • Name extends string

  Parameters

  • target: ArrayBuffer
  • name: Name
  • value: StorageValue<Schema[Name]>
  • result: StorageWriteResult

  Returns StorageWriteResult