Class Table<R>

Table structure wraps Struct-based entries for tables present within ZNP NV memory.

Type Parameters

R extends BuiltStruct

Implements

SerializableMemoryObject

Index

Accessors

capacity entries free freeCount used usedCount

Methods

build getNextFree indexOf inlineHeader occupancy serialize struct new

Accessors

capacity

get capacity(): number
Return total capacity of the table.

Returns number
- Defined in src/adapter/z-stack/structs/table.ts:35

entries

get entries(): R[]
Returns all entries within table.

Returns R[]
- Defined in src/adapter/z-stack/structs/table.ts:42

free

get free(): R[]
Returns all unused entries.

Returns R[]
- Defined in src/adapter/z-stack/structs/table.ts:58

freeCount

get freeCount(): number
Return number of records marked as free.

Returns number
- Defined in src/adapter/z-stack/structs/table.ts:67

used

get used(): R[]
Returns all used entries.

Returns R[]
- Defined in src/adapter/z-stack/structs/table.ts:49

usedCount

get usedCount(): number
Return number of records marked as used.

Returns number
- Defined in src/adapter/z-stack/structs/table.ts:74

Methods

build

build(
data: Buffer | Buffer[],
alignment?: StructMemoryAlignment,
): BuiltTable<R, Table<R>>
Builds the table from existing buffer or buffers representing entries.
Parameters
- data: Buffer | Buffer[]
  Buffer to populate table from.
- Optionalalignment: StructMemoryAlignment
  Memory alignment of the source platform.
Returns BuiltTable<R, Table<R>>
- Defined in src/adapter/z-stack/structs/table.ts:152
build(capacity: number): BuiltTable<R, Table<R>>
Creates an empty table with set capacity.
Parameters
- capacity: number
  Capacity to create the table with.
Returns BuiltTable<R, Table<R>>
- Defined in src/adapter/z-stack/structs/table.ts:159

getNextFree

getNextFree(): R
Return next free entry or null if no entries are free within the table.

Returns R
- Defined in src/adapter/z-stack/structs/table.ts:81

indexOf

indexOf(entry: R): null | number
Returns index of element in table.
Parameters
- entry: R
  Entry to resolve index for.
Returns null | number
- Defined in src/adapter/z-stack/structs/table.ts:90

inlineHeader

inlineHeader(hasInlineHeader?: boolean): this
Sets whether the table has a table header containing a 16-bit unsigned used table length.
Parameters
- hasInlineHeader: boolean = true
  Sets whether table has record count header.
Returns this
- Defined in src/adapter/z-stack/structs/table.ts:141

occupancy

occupancy(fn: (entry: R) => boolean): this
Applies function to determine table entry occupancy. This function is invoked with an entry instance and returns boolean indicating if the entry is occupied or not.
Parameters
- fn: (entry: R) => boolean
  Function to determine entry occupancy.
Returns this
- Defined in src/adapter/z-stack/structs/table.ts:120

serialize

serialize(alignment?: StructMemoryAlignment): Buffer
Export the table in target platform format.
Parameters
- alignment: StructMemoryAlignment = 'unaligned'
  Memory alignment to use for export.
Returns Buffer
Implementation of SerializableMemoryObject.serialize
- Defined in src/adapter/z-stack/structs/table.ts:99

struct

struct(entryStructFactory: StructFactorySignature<R>): this
Defines a struct factory for entries contained within table.
Parameters
- entryStructFactory: StructFactorySignature<R>
  Struct factory.
Returns this
- Defined in src/adapter/z-stack/structs/table.ts:130

`Static`new

new<R extends BuiltStruct>(): Table<R>
Create a new table builder.
Type Parameters
- R extends BuiltStruct
Returns Table<R>
- Defined in src/adapter/z-stack/structs/table.ts:17

Class Table<R>

Type Parameters

Implements

Index

Accessors

Methods

Accessors

capacity

Returns number

entries

Returns R[]

free

Returns R[]

freeCount

Returns number

used

Returns R[]

usedCount

Returns number

Methods

build

Parameters

Returns BuiltTable<R, Table<R>>

Parameters

Returns BuiltTable<R, Table<R>>

getNextFree

Returns R

indexOf

Parameters

Returns null | number

inlineHeader

Parameters

Returns this

occupancy

Parameters

Returns this

serialize

Parameters

Returns Buffer

struct

Parameters

Returns this

Staticnew

Type Parameters

Returns Table<R>

Settings

On This Page

`Static`new