nupp.serde.native

The native codec saves values as a compact binary frame on a native LuaJIT host. See Serialization bindings for what a frame preserves.

local serde = require("nupp.serde")
local native = require("nupp.serde.native")
local record Save
    level: integer
    inventory: {string}
end
local saves = serde.binding(Save)
local bytes = native.encode(saves, new Save(level = 12, inventory = {"key"}))
local restored = native.decode(saves, bytes)
assert(restored.level == 12 and restored.inventory[1] == "key")

The frame keeps everything a nupp.serde.Writer can say: exact 64-bit integers, float widths, decimals, bytes, timestamps, and document boundaries. Members are stored by name, so a binding can gain optional fields and still read older frames.

A frame holds a finite tree of values. It does not preserve shared identity or cycles, never runs code from its input, and cannot hold process handles. Its input is bounded at 16 MiB, 128 levels of nesting, and a million values.

The frame is versioned and a reader rejects any version it does not know. It is specific to LuaJIT: this module raises on other hosts before it selects a binding. Use nupp.serde.json for data that leaves the machine.

interface Codec ...

encode: function<T>(self, binding: core.Binding<T>, borrows value: T): string

decode: function<T>(self, binding: core.Binding<T>, bytes: string): T

encodeDocument: function<D>(self, adapter: core.DocumentAdapter<D>, borrows value: D): string

decodeDocument: function<D>(self, adapter: core.DocumentAdapter<D>, bytes: string): D

clear: function(self): nil

cachedBindings: function(self): integer

function codec(capacity: integer?): Codec

function decode<T>(binding: core.Binding<T>, bytes: string): T

function decodeDocument<D>(adapter: core.DocumentAdapter<D>, bytes: string): D

function encode<T>(binding: core.Binding<T>, borrows value: T): string

function encodeDocument<D>(adapter: core.DocumentAdapter<D>, borrows value: D): string

local document = require("nupp.serde.document")
local native = require("nupp.serde.native")
local value = document.list({document.numberToken("1e400"), document.bytes("\0\1")})
local restored = native.decodeDocument(document.adapter(), native.encodeDocument(document.adapter(), value))
assert(restored:at(1):numberToken() == "1e400" and restored:at(2):bytes() == "\0\1")

const identity: table