`nupp.mem.representation.spi`

Implementation interfaces consumed during ordinary module initialization. Discover with nupp.spi.load; the consumer chooses the unique highest priority. Omitted priority is zero. Importing these declarations loads no implementation.

Module contents

Types

Type	Kind	Description
`CastElements`	type	Casts storage to elements of any supplied ctype.
`CstorageProvider`	interface	A coherent family of physical storage operations.
`StructvalueProvider`	interface	Struct-value operations supplied as part of the storage family.

Types#

`CastElements`type#

type CastElements = function<T>(element: ctype<T>, pointer: any): any

Casts storage to elements of any supplied ctype.

The implementation must remain generic in T and use the target's representation; accepting one particular element type is not sufficient.

`CstorageProvider`interface#

interface CstorageProvider ...

A coherent family of physical storage operations.

representation is native, the only family Nupp compiles for, and the facade checks it before publishing this table: a provider built for some other layout cannot be selected into a program whose layout is already compiled.

Allocation, descriptors, scalar codecs, and copies must agree on byte order, alignment, width, and pointer units. Decode inputs contain at least the scalar width in bytes. Borrowed views preserve source lifetimes; borrows, generic casts, and const views are part of the implementation contract. Opaque values in these signatures carry provider storage, not permission to change a compiled representation at runtime.

Members

Name	Kind	Description
`priority`	field
`boundedCount`	method	Returns the requested count after any representation-specific extent check.
`representation`	field	The storage family this table implements, which must be native.
`structs`	field	Struct descriptors and row operations sharing this storage family.
`layout`	field	Returns target layout facts for a type or descriptor, where the family reports them.
`scalar`	method	Returns the canonical descriptor for a scalar kind within this provider.
`descriptor`	method	Reports layout and bounds for a provider value.
`reference`	field	Creates a deferred descriptor reference for recursive layouts.
`allocateArray`	method	Allocates count elements of the supplied descriptor.
`allocateBytes`	method	Allocates a writable byte region containing count bytes.
`borrowString`	method	Returns a read-only byte view whose lifetime borrows the source string.
`castBytes`	method	Returns a read-only byte view borrowing the pointer owner.
`castElements`	field	Interprets a pointer using any supplied element ctype.
`copy`	method	Copies count bytes into destination without replacing its owner.
`fill`	method	Fills count bytes in destination with the given byte value.
`sizeOf`	method	Returns the descriptor size in bytes.
`string`	method	Copies count source bytes into an independent Lua string.
`decodeUint8`	method	Decodes a unsigned 8-bit integer using the target storage byte order.
`encodeUint8`	method	Encodes a unsigned 8-bit integer using the target storage byte order.
`decodeInt8`	method	Decodes a signed 8-bit integer using the target storage byte order.
`encodeInt8`	method	Encodes a signed 8-bit integer using the target storage byte order.
`decodeUint16`	method	Decodes a unsigned 16-bit integer using the target storage byte order.
`encodeUint16`	method	Encodes a unsigned 16-bit integer using the target storage byte order.
`decodeInt16`	method	Decodes a signed 16-bit integer using the target storage byte order.
`encodeInt16`	method	Encodes a signed 16-bit integer using the target storage byte order.
`decodeUint32`	method	Decodes a unsigned 32-bit integer using the target storage byte order.
`encodeUint32`	method	Encodes a unsigned 32-bit integer using the target storage byte order.
`decodeInt32`	method	Decodes a signed 32-bit integer using the target storage byte order.
`encodeInt32`	method	Encodes a signed 32-bit integer using the target storage byte order.
`decodeUint64`	method	Decodes a unsigned 64-bit integer using the target storage byte order.
`encodeUint64`	method	Encodes a unsigned 64-bit integer using the target storage byte order.
`decodeInt64`	method	Decodes a signed 64-bit integer using the target storage byte order.
`encodeInt64`	method	Encodes a signed 64-bit integer using the target storage byte order.
`decodeFloat32`	method	Decodes an IEEE-754 binary32 value using the target storage byte order.
`encodeFloat32`	method	Encodes an IEEE-754 binary32 value using the target storage byte order.
`decodeFloat64`	method	Decodes an IEEE-754 binary64 value using the target storage byte order.
`encodeFloat64`	method	Encodes an IEEE-754 binary64 value using the target storage byte order.

`priority`field#

priority: integer?

@readonly

`boundedCount`method#

boundedCount: function(borrows source: any, count: integer): integer

@readonly

Returns the requested count after any representation-specific extent check. Callers remain responsible for valid native pointer extents.

Arguments

Name	Type	Description
`borrows source`	`any`
`count`	`integer`

Returns

Type	Description
`integer`

`representation`field#

representation: string

@readonly

The storage family this table implements, which must be native.

`structs`field#

structs: StructvalueProvider?

@readonly

Struct descriptors and row operations sharing this storage family.

`layout`field#

layout: (function(subject: any): any)?

@readonly

Returns target layout facts for a type or descriptor, where the family reports them.

`scalar`method#

scalar: function(kind: string): any

@readonly

Returns the canonical descriptor for a scalar kind within this provider.

Arguments

Name	Type	Description
`kind`	`string`

Returns

Type	Description
`any`

`descriptor`method#

descriptor: function(value: any): any

@readonly

Reports layout and bounds for a provider value.

Arguments

Name	Type	Description
`value`	`any`

Returns

Type	Description
`any`

`reference`field#

reference: (function(resolve: function(): any): any)?

@readonly

Creates a deferred descriptor reference for recursive layouts.

`allocateArray`method#

allocateArray: function(element: any, count: integer): any

@readonly

Allocates count elements of the supplied descriptor.

Arguments

Name	Type	Description
`element`	`any`
`count`	`integer`

Returns

Type	Description
`any`

`allocateBytes`method#

allocateBytes: function(count: integer): uint8[?]

@readonly

Allocates a writable byte region containing count bytes.

Arguments

Name	Type	Description
`count`	`integer`

Returns

Type	Description
`uint8[?]`

`borrowString`method#

borrowString: function(borrows bytes: string): const uint8[?] borrows (bytes)

@readonly

Returns a read-only byte view whose lifetime borrows the source string.

Arguments

Name	Type	Description
`borrows bytes`	`string`

Returns

Type	Description
`const uint8[?] borrows (bytes)`

`castBytes`method#

castBytes: function(borrows pointer: any): const uint8[?] borrows (pointer)

@readonly

Returns a read-only byte view borrowing the pointer owner.

Arguments

Name	Type	Description
`borrows pointer`	`any`

Returns

Type	Description
`const uint8[?] borrows (pointer)`

`castElements`field#

castElements: CastElements

@readonly

Interprets a pointer using any supplied element ctype.

`copy`method#

copy: function(borrows destination: any, borrows source: any, count: integer): nil

@readonly

Copies count bytes into destination without replacing its owner.

Arguments

Name	Type	Description
`borrows destination`	`any`
`borrows source`	`any`
`count`	`integer`

Returns

Type	Description
`nil`

`fill`method#

fill: function(destination: any, count: integer, value: integer): nil

@readonly

Fills count bytes in destination with the given byte value.

Arguments

Name	Type	Description
`destination`	`any`
`count`	`integer`
`value`	`integer`

Returns

Type	Description
`nil`

`sizeOf`method#

sizeOf: function(element: any): integer

@readonly

Returns the descriptor size in bytes.

Arguments

Name	Type	Description
`element`	`any`

Returns

Type	Description
`integer`

`string`method#

string: function(borrows source: any, count: integer): string

@readonly

Copies count source bytes into an independent Lua string.

Arguments

Name	Type	Description
`borrows source`	`any`
`count`	`integer`

Returns

Type	Description
`string`

`decodeUint8`method#

decodeUint8: function(bytes: string): uint32

@readonly

Decodes a unsigned 8-bit integer using the target storage byte order.

Arguments

Name	Type	Description
`bytes`	`string`

Returns

Type	Description
`uint32`

`encodeUint8`method#

encodeUint8: function(value: uint32): string

@readonly

Encodes a unsigned 8-bit integer using the target storage byte order.

Arguments

Name	Type	Description
`value`	`uint32`

Returns

Type	Description
`string`

`decodeInt8`method#

decodeInt8: function(bytes: string): int32

@readonly

Decodes a signed 8-bit integer using the target storage byte order.

Arguments

Name	Type	Description
`bytes`	`string`

Returns

Type	Description
`int32`

`encodeInt8`method#

encodeInt8: function(value: int32): string

@readonly

Encodes a signed 8-bit integer using the target storage byte order.

Arguments

Name	Type	Description
`value`	`int32`

Returns

Type	Description
`string`

`decodeUint16`method#

decodeUint16: function(bytes: string): uint32

@readonly

Decodes a unsigned 16-bit integer using the target storage byte order.

Arguments

Name	Type	Description
`bytes`	`string`

Returns

Type	Description
`uint32`

`encodeUint16`method#

encodeUint16: function(value: uint32): string

@readonly

Encodes a unsigned 16-bit integer using the target storage byte order.

Arguments

Name	Type	Description
`value`	`uint32`

Returns

Type	Description
`string`

`decodeInt16`method#

decodeInt16: function(bytes: string): int32

@readonly

Decodes a signed 16-bit integer using the target storage byte order.

Arguments

Name	Type	Description
`bytes`	`string`

Returns

Type	Description
`int32`

`encodeInt16`method#

encodeInt16: function(value: int32): string

@readonly

Encodes a signed 16-bit integer using the target storage byte order.

Arguments

Name	Type	Description
`value`	`int32`

Returns

Type	Description
`string`

`decodeUint32`method#

decodeUint32: function(bytes: string): uint32

@readonly

Decodes a unsigned 32-bit integer using the target storage byte order.

Arguments

Name	Type	Description
`bytes`	`string`

Returns

Type	Description
`uint32`

`encodeUint32`method#

encodeUint32: function(value: uint32): string

@readonly

Encodes a unsigned 32-bit integer using the target storage byte order.

Arguments

Name	Type	Description
`value`	`uint32`

Returns

Type	Description
`string`

`decodeInt32`method#

decodeInt32: function(bytes: string): int32

@readonly

Decodes a signed 32-bit integer using the target storage byte order.

Arguments

Name	Type	Description
`bytes`	`string`

Returns

Type	Description
`int32`

`encodeInt32`method#

encodeInt32: function(value: int32): string

@readonly

Encodes a signed 32-bit integer using the target storage byte order.

Arguments

Name	Type	Description
`value`	`int32`

Returns

Type	Description
`string`

`decodeUint64`method#

decodeUint64: function(bytes: string): uint64

@readonly

Decodes a unsigned 64-bit integer using the target storage byte order.

Arguments

Name	Type	Description
`bytes`	`string`

Returns

Type	Description
`uint64`

`encodeUint64`method#

encodeUint64: function(value: uint64): string

@readonly

Encodes a unsigned 64-bit integer using the target storage byte order.

Arguments

Name	Type	Description
`value`	`uint64`

Returns

Type	Description
`string`

`decodeInt64`method#

decodeInt64: function(bytes: string): int64

@readonly

Decodes a signed 64-bit integer using the target storage byte order.

Arguments

Name	Type	Description
`bytes`	`string`

Returns

Type	Description
`int64`

`encodeInt64`method#

encodeInt64: function(value: int64): string

@readonly

Encodes a signed 64-bit integer using the target storage byte order.

Arguments

Name	Type	Description
`value`	`int64`

Returns

Type	Description
`string`

`decodeFloat32`method#

decodeFloat32: function(bytes: string): float

@readonly

Decodes an IEEE-754 binary32 value using the target storage byte order.

Arguments

Name	Type	Description
`bytes`	`string`

Returns

Type	Description
`float`

`encodeFloat32`method#

encodeFloat32: function(value: number): string

@readonly

Encodes an IEEE-754 binary32 value using the target storage byte order.

Arguments

Name	Type	Description
`value`	`number`

Returns

Type	Description
`string`

`decodeFloat64`method#

decodeFloat64: function(bytes: string): number

@readonly

Decodes an IEEE-754 binary64 value using the target storage byte order.

Arguments

Name	Type	Description
`bytes`	`string`

Returns

Type	Description
`number`

`encodeFloat64`method#

encodeFloat64: function(value: number): string

@readonly

Encodes an IEEE-754 binary64 value using the target storage byte order.

Arguments

Name	Type	Description
`value`	`number`

Returns

Type	Description
`string`

`StructvalueProvider`interface#

interface StructvalueProvider ...

Struct-value operations supplied as part of the storage family.

Descriptors, arrays, and constructed values must agree with compiler layouts and canonical struct declarations. referenceValued reports whether a row reference addresses the underlying storage. The storage implementation supplies compatible struct operations as part of the same family.

Members

Name	Kind	Description
`scalar`	method	Returns a scalar descriptor accepted by define and array.
`array`	method	Allocates count elements using this family's element descriptor.
`define`	method	Constructs a type descriptor from a compiler layout and method table.
`referenceValued`	field	Whether row references address their underlying storage.

`scalar`method#

scalar: function(kind: string): any

@readonly

Returns a scalar descriptor accepted by define and array.

Arguments

Name	Type	Description
`kind`	`string`

Returns

Type	Description
`any`

`array`method#

array: function(element: any, count: integer): any

@readonly

Allocates count elements using this family's element descriptor.

Arguments

Name	Type	Description
`element`	`any`
`count`	`integer`

Returns

Type	Description
`any`

`define`method#

define: function(layout: any, methods: table): any

@readonly

Constructs a type descriptor from a compiler layout and method table.

Arguments

Name	Type	Description
`layout`	`any`
`methods`	`table`

Returns

Type	Description
`any`

`referenceValued`field#

referenceValued: boolean

@readonly

Whether row references address their underlying storage.

nupp.mem.representation.spi

Module contents

Types

Types#

CastElementstype#

CstorageProviderinterface#

Members

priorityfield#

boundedCountmethod#

Arguments

Returns

representationfield#

structsfield#

layoutfield#

scalarmethod#

Arguments

Returns

descriptormethod#

Arguments

Returns

referencefield#

allocateArraymethod#

Arguments

Returns

allocateBytesmethod#

Arguments

Returns

borrowStringmethod#

Arguments

Returns

castBytesmethod#

Arguments

Returns

castElementsfield#

copymethod#

Arguments

Returns

fillmethod#

Arguments

Returns

sizeOfmethod#

Arguments

Returns

stringmethod#

Arguments

Returns

decodeUint8method#

Arguments

Returns

encodeUint8method#

Arguments

Returns

decodeInt8method#

Arguments

Returns

encodeInt8method#

Arguments

Returns

decodeUint16method#

Arguments

Returns

encodeUint16method#

Arguments

Returns

decodeInt16method#

Arguments

Returns

encodeInt16method#

Arguments

Returns

decodeUint32method#

Arguments

Returns

encodeUint32method#

Arguments

Returns

decodeInt32method#

Arguments

Returns

encodeInt32method#

`nupp.mem.representation.spi`

`CastElements`type#

`CstorageProvider`interface#

`priority`field#

`boundedCount`method#

`representation`field#

`structs`field#

`layout`field#

`scalar`method#

`descriptor`method#

`reference`field#

`allocateArray`method#

`allocateBytes`method#

`borrowString`method#

`castBytes`method#

`castElements`field#

`copy`method#

`fill`method#

`sizeOf`method#

`string`method#

`decodeUint8`method#

`encodeUint8`method#

`decodeInt8`method#

`encodeInt8`method#

`decodeUint16`method#

`encodeUint16`method#

`decodeInt16`method#

`encodeInt16`method#

`decodeUint32`method#

`encodeUint32`method#

`decodeInt32`method#

`encodeInt32`method#

`decodeUint64`method#

`encodeUint64`method#

`decodeInt64`method#

`encodeInt64`method#

`decodeFloat32`method#

`encodeFloat32`method#

`decodeFloat64`method#

`encodeFloat64`method#

`StructvalueProvider`interface#

`scalar`method#

`array`method#

`define`method#

`referenceValued`field#