`nupp.serde.document`

A document is a value without a schema, which any codec reads and writes. This module holds the Document tree, conversion between bound values and documents, typed views, and saved nupp.util.Store snapshots; see Serialization bindings for the guide.

local document = require("nupp.serde.document")
local json = require("nupp.serde.json")
local value = json.decodeDocument(document.adapter(), '{"id":18446744073709551615,"tags":["a","b"]}')
assert(value.kind == "structure")
assert(assert(value:get("id")):numberToken() == "18446744073709551615")
assert(assert(value:get("tags")):at(2):string() == "b")
assert(json.encodeDocument(document.adapter(), value) == '{"id":18446744073709551615,"tags":["a","b"]}')

A document keeps what the codec read without rounding it: integers beyond 2^53 stay exact, decimals keep their digits, floats keep their width, and absent, null, and present members stay distinct. It also keeps the nupp.serde.Context it was read under, so a protocol can tell where it came from.

A document-valued member, one a schema declares without describing, is a document boundary: boundary wraps its contents so a protocol can treat the member separately from the value inside it.

from and into cross between a bound value and its document, which is how a value moves between codecs or is inspected without knowing its type:

local serde = require("nupp.serde")
local document = require("nupp.serde.document")
local record Point
    x: integer
    y: integer
end
local points = serde.binding(Point)
local tree = document.from(points, new Point(x = 1, y = 2))
assert(assert(tree:get("y")):numberToken() == "2")
assert(document.into(points, tree).x == 1)

Module contents

Types

Type	Kind	Description
`Decoder`	interface	Constructs values of one binding from documents, without looking the binding up each time.
`Document`	record	An immutable value tree.
`Entry`	record	A named structure member, as object takes and Document:field returns.
`MapEntry`	record	A map entry, whose key is itself a document.
`Migration`	interface	Upgrades a saved entry from an older version to the current one.
`StoreEntry`	record	One saved store entry: its name, version, and document.
`StoreRegistry`	interface	Saves and restores the entries of a nupp.util.Store by name and version.
`StoreSnapshot`	record	The saved entries of a store.
`View`	record	A bound value presented as a document, without building the tree.

Functions

Function	Kind	Description
`adapter`	function	Returns the adapter that reads and writes a Document as its contents.
`atom`	function	A model-defined atom, snapshotted so the document owns it.
`bigInteger`	function	An integer of unbounded size, from its decimal text.
`boolean`	function	A boolean.
`boundary`	function	A document boundary around contents, for a document-valued member.
`bytes`	function	Binary data.
`cachedBindings`	function	Returns how many bindings the decoder cache holds.
`clear`	function	Empties the decoder cache.
`decimal`	function	An exact decimal.
`decoder`	function	Returns a binding's Decoder, cached by binding identity.
`float`	function	A float with its width.
`from`	function	Converts a bound value to its document.
`integer`	function	A fixed-width integer.
`into`	function	Constructs a bound value from a document.
`list`	function	A list.
`map`	function	A map whose keys are documents.
`null`	function	A null.
`numberToken`	function	A number kept as the lexeme it was written as, such as a JSON number too large for any integer width.
`object`	function	A structure, from its members in order.
`reader`	function	Reads a document through the nupp.serde.DocumentReader contract, as a codec's own reader would.
`snapshot`	function	Copies a document into one that owns all of its values.
`storeBinding`	function	Returns the binding a codec writes and reads a StoreSnapshot through.
`storeRegistry`	function	Starts an empty StoreRegistry.
`string`	function	A string.
`timestamp`	function	A timestamp.
`tuple`	function	A tuple: a list whose length is part of its shape.
`union`	function	A union: the one member that is set.
`view`	function	Presents a Copyable value as a View.
`viewAdapter`	function	Returns the document adapter for views of one binding.
`withContext`	function	The same document with a context attached.

Types#

`Decoder`interface#

interface Decoder<T> ...

Constructs values of one binding from documents, without looking the binding up each time.

Type parameters

Name	Description
`T`

Members

Name	Kind	Description
`read`	method	Constructs a value from a document.

`read`method#

read: function(self, value: documents.Document): T

Constructs a value from a document.

The binding's construction runs exactly as a codec decoder's would, so required fields and defaults are checked the same way.

Arguments

Name	Type	Description
`?`	`self`
`value`	`documents.Document`	the document

Returns

Type	Description
`T`	the value

Raises

Type	Condition
`nupp.serde.Error`	when the document does not fit the binding
`string`	when the binding does not consume the document

`Document`record#

record Document ...

An immutable value tree.

kind says which accessor applies: string() for a string, at(i) and size() for a list or tuple, get(name) and field(i) for a structure, entry(i) for a map, document() for a boundary. get returns nil on any other kind; a scalar accessor raises on a document of another kind.

Members

Name	Kind	Description
`kind`	field	The kind of value the document holds, which decides the accessor that applies.
`text`	field
`flag`	field
`time`	field
`integerValue`	field
`decimalValue`	field
`floatValue`	field
`atomValue`	field
`entries`	field
`elements`	field
`fields`	field
`source`	field
`size`	method	Returns how many values the document holds directly.
`at`	method	Returns the element at a position in a list or tuple.
`get`	method	Finds the member of a structure or union by name.
`string`	method	Returns the string a string document holds.
`numberToken`	method	Returns the lexeme a numberToken document holds.
`boolean`	method	Returns the value a boolean document holds.
`integer`	method	Returns the fixed-width integer an integer document holds.
`decimal`	method	Returns the exact decimal a decimal document holds.
`float`	method	Returns the float a float document holds.
`bytes`	method	Returns the binary data a bytes document holds.
`bigInteger`	method	Returns the integer a bigInteger document holds.
`timestamp`	method	Returns the timestamp a timestamp document holds.
`atom`	method	Returns a snapshot of the atom an atom document holds.
`entry`	method	Returns the entry at a position in a map document.
`field`	method	Returns the member at a position in a structure or union document.
`document`	method	Returns the contents of a document boundary.
`context`	method	Returns the context the document carries.

`kind`field#

kind: core.Kind

@readonly

The kind of value the document holds, which decides the accessor that applies.

`text`field#

text: string?

@private@readonly

`flag`field#

flag: boolean?

@private@readonly

`time`field#

time: core.Timestamp?

@private@readonly

`integerValue`field#

integerValue: core.Integer?

@private@readonly

`decimalValue`field#

decimalValue: core.Decimal?

@private@readonly

`floatValue`field#

floatValue: core.Float?

@private@readonly

`atomValue`field#

atomValue: core.Atom?

@private@readonly

`entries`field#

entries: {MapEntry}?

@private@readonly

`elements`field#

elements: {Document}

@private@readonly

`fields`field#

fields: {Entry}

@private@readonly

`source`field#

source: core.Context?

@private@readonly

`size`method#

size: function size(self): integer

Returns how many values the document holds directly.

A structure or union counts its members, a map its entries, and a list or tuple its elements. A boundary counts its contents as one, and any other kind returns 0.

Arguments

Name	Type	Description
`self`	`any`

Returns

Type	Description
`integer`	the count

`at`method#

at: function at(self, index: integer): Document

Returns the element at a position in a list or tuple.

Arguments

Name	Type	Description
`self`	`any`
`index`	`integer`	the 1-based position

Returns

Type	Description
`Document`	the element

Raises

Type	Condition
`string`	when no element is at the index

`get`method#

get: function get(self, name: string): Document?

Finds the member of a structure or union by name.

Any other kind has no members, so it returns nil.

Arguments

Name	Type	Description
`self`	`any`
`name`	`string`	the member name

Returns

Type	Description
`Document?`	the member's value, or nil when no member has the name

`string`method#

string: function string(self): string

Returns the string a string document holds.

Arguments

Name	Type	Description
`self`	`any`

Returns

Type	Description
`string`

Raises

Type	Condition
`string`	when the document is not a string

`numberToken`method#

numberToken: function numberToken(self): string

Returns the lexeme a numberToken document holds.

Arguments

Name	Type	Description
`self`	`any`

Returns

Type	Description
`string`	the number as it was written

Raises

Type	Condition
`string`	when the document is not a number token

`boolean`method#

boolean: function boolean(self): boolean

Returns the value a boolean document holds.

Arguments

Name	Type	Description
`self`	`any`

Returns

Type	Description
`boolean`

Raises

Type	Condition
`string`	when the document is not a boolean

`integer`method#

integer: function integer(self): core.Integer

Returns the fixed-width integer an integer document holds.

Arguments

Name	Type	Description
`self`	`any`

Returns

Type	Description
`core.Integer`	the integer's decimal digits, width, and signedness

Raises

Type	Condition
`string`	when the document is not an integer

`decimal`method#

decimal: function decimal(self): core.Decimal

Returns the exact decimal a decimal document holds.

Arguments

Name	Type	Description
`self`	`any`

Returns

Type	Description
`core.Decimal`	the decimal's coefficient and exponent

Raises

Type	Condition
`string`	when the document is not a decimal

`float`method#

float: function float(self): core.Float

Returns the float a float document holds.

Arguments

Name	Type	Description
`self`	`any`

Returns

Type	Description
`core.Float`	the float's value and width

Raises

Type	Condition
`string`	when the document is not a float

`bytes`method#

bytes: function bytes(self): string

Returns the binary data a bytes document holds.

Arguments

Name	Type	Description
`self`	`any`

Returns

Type	Description
`string`	the data as a string

Raises

Type	Condition
`string`	when the document is not bytes

`bigInteger`method#

bigInteger: function bigInteger(self): string

Returns the integer a bigInteger document holds.

Arguments

Name	Type	Description
`self`	`any`

Returns

Type	Description
`string`	the integer's decimal text

Raises

Type	Condition
`string`	when the document is not a big integer

`timestamp`method#

timestamp: function timestamp(self): core.Timestamp

Returns the timestamp a timestamp document holds.

Arguments

Name	Type	Description
`self`	`any`

Returns

Type	Description
`core.Timestamp`

Raises

Type	Condition
`string`	when the document is not a timestamp

`atom`method#

atom: function atom(self): core.Atom

Returns a snapshot of the atom an atom document holds.

Each call returns a new snapshot, so the document keeps its own.

Arguments

Name	Type	Description
`self`	`any`

Returns

Type	Description
`core.Atom`

Raises

Type	Condition
`string`	when the document is not an atom

`entry`method#

entry: function entry(self, index: integer): MapEntry

Returns the entry at a position in a map document.

Arguments

Name	Type	Description
`self`	`any`
`index`	`integer`	the 1-based position

Returns

Type	Description
`MapEntry`	the entry

Raises

Type	Condition
`string`	when the document is not a map
`string`	when no entry is at the index

`field`method#

field: function field(self, index: integer): Entry

Returns the member at a position in a structure or union document.

Arguments

Name	Type	Description
`self`	`any`
`index`	`integer`	the 1-based position

Returns

Type	Description
`Entry`	the member

Raises

Type	Condition
`string`	when the document is neither a structure nor a union
`string`	when no member is at the index

`document`method#

document: function document(self): Document

Returns the contents of a document boundary.

Arguments

Name	Type	Description
`self`	`any`

Returns

Type	Description
`Document`

Raises

Type	Condition
`string`	when the document is not a boundary

`context`method#

context: function context(self): core.Context?

Returns the context the document carries.

A decoded document carries the context it was read under, and nupp.serde.document.withContext attaches one to any document.

Arguments

Name	Type	Description
`self`	`any`

Returns

Type	Description
`core.Context?`	the context, or nil when the document has none

`Entry`record#

record Entry ...

A named structure member, as object takes and Document:field returns.

Members

Name	Kind	Description
`name`	field	The member's name.
`value`	field	The member's value.

`name`field#

name: string

@readonly

The member's name.

`value`field#

value: Document

@readonly

The member's value.

`MapEntry`record#

record MapEntry ...

A map entry, whose key is itself a document.

Members

Name	Kind	Description
`key`	field	The entry's key.
`value`	field	The entry's value.

`key`field#

key: Document

@readonly

The entry's key.

`value`field#

value: Document

@readonly

The entry's value.

`Migration`interface#

interface Migration ...

Upgrades a saved entry from an older version to the current one.

Members

Name	Kind	Description
`apply`	method	Upgrades a saved entry's document to the registered version.

`apply`method#

apply: function(self, previousVersion: integer, value: documents.Document): documents.Document

Upgrades a saved entry's document to the registered version.

Loading calls it once per older entry, and its result is constructed through the registered binding, so it must return the current version's document directly.

Arguments

Name	Type	Description
`?`	`self`
`previousVersion`	`integer`	the version the entry was saved at
`value`	`documents.Document`	the saved document

Returns

Type	Description
`documents.Document`	the document at the registered version

`StoreEntry`record#

record StoreEntry ...

One saved store entry: its name, version, and document.

Members

Name	Kind	Description
`name`	field	The name the entry's key is registered under.
`version`	field	The version the entry was saved at.
`value`	field	The entry's value, as a document.

`name`field#

name: string

@readonly

The name the entry's key is registered under.

`version`field#

version: integer

@readonly

The version the entry was saved at.

`value`field#

value: documents.Document

@readonly

The entry's value, as a document.

`StoreRegistry`interface#

interface StoreRegistry ...

Saves and restores the entries of a nupp.util.Store by name and version.

Each registered key names its entry, its binding, its current version, and the migration that upgrades an older one. Saving produces a StoreSnapshot any codec can carry through storeBinding.

local serde = require("nupp.serde")
local document = require("nupp.serde.document")
local json = require("nupp.serde.json")
local record Settings
    volume: integer
end
local settings: nupp.util.Key<Settings> = nupp.util.newKey()
local registry = document.storeRegistry()
registry:register("settings", settings, serde.binding(Settings), 1, nil)

local store = nupp.util.newStore()
store:set(settings, new Settings(volume = 7))
local bytes = json.encode(document.storeBinding(), registry:save(store))

local restored = registry:load(json.decode(document.storeBinding(), bytes), "reject")
assert(assert(restored:get(settings)).volume == 7)

Members

Name	Kind	Description
`register`	method	Registers a store key for saving under a persistent name.
`save`	method	Saves the registered keys that hold a value in a store.
`load`	method	Restores a snapshot's entries into a new store.

`register`method#

register: function<T is nupp.Copyable>(
    self,
    name: string,
    key: util.Key<T>,
    binding: core.Binding<T>,
    version: integer,
    migration: Migration?
): nil

Registers a store key for saving under a persistent name.

Arguments

Name	Type	Description
`?`	`self`
`name`	`string`	the name the key's entry is saved under
`key`	`util.Key<T>`	the store key
`binding`	`core.Binding<T>`	the binding the key's value is saved and restored through
`version`	`integer`	the current version, a positive integer
`migration`	`Migration?`	the migration that upgrades an older entry, or nil when only the current version loads

Returns

Type	Description
`nil`

Raises

Type	Condition
`string`	when the name is empty or already registered
`string`	when the key is already registered
`string`	when the version is not a positive integer

`save`method#

save: function(self, borrows store: util.Store): Snapshot

Saves the registered keys that hold a value in a store.

Entries are in registration order, each at its key's current version. A registered key the store holds no value under is left out.

Arguments

Name	Type	Description
`?`	`self`
`borrows store`	`util.Store`	the store to read, which is borrowed

Returns

Type	Description
`Snapshot`	the snapshot

`load`method#

load: function(self, snapshot: Snapshot, unknown: "reject" | "skip"): util.Store

Restores a snapshot's entries into a new store.

An entry at its key's registered version is constructed through the binding as it is. An older entry passes through the key's migration first. A newer entry, or an older one with no migration, raises.

Arguments

Name	Type	Description
`?`	`self`
`snapshot`	`Snapshot`	the saved entries
`unknown`	`"reject" \| "skip"`	"reject" to raise on an entry whose name is not registered, or "skip" to leave it out

Returns

Type	Description
`util.Store`	the store holding every restored entry

Raises

Type	Condition
`string`	when the snapshot's format is not 1
`string`	when two entries share a name
`string`	when an entry's name is not registered and `unknown` is "reject"
`string`	when an entry's version is not a positive integer, is newer than the registered version, or is older with no migration
`nupp.serde.Error`	when an entry's document does not fit its binding
`string`	when an entry's document constructs a nil value

`StoreSnapshot`record#

record StoreSnapshot ...

The saved entries of a store.

Members

Name	Kind	Description
`format`	field	The snapshot layout version, which loading requires to be 1.
`entries`	field	The saved entries.

`format`field#

format: integer

@readonly

The snapshot layout version, which loading requires to be 1.

`entries`field#

entries: {Entry}

@readonly

The saved entries.

`View`record#

record View<T is nupp.Copyable> ...

A bound value presented as a document, without building the tree.

A codec reads the current value through the binding each time, so a view follows changes to its owner. snapshot() reconstructs a detached copy, and document() materializes the tree when one is wanted.

local serde = require("nupp.serde")
local document = require("nupp.serde.document")
local json = require("nupp.serde.json")
local record Counter
    count: integer
end
local counters = serde.binding(Counter)
local owner = new Counter(count = 1)
local live = document.view(counters, owner)
local frozen = live:snapshot()
owner.count = 2
local views = document.viewAdapter(counters)
assert(json.encodeDocument(views, live) == '{"count":2}')
assert(json.encodeDocument(views, frozen) == '{"count":1}')

Type parameters

Name	Description
`T`

Members

Name	Kind	Description
`binding`	field	The binding the view reads its value through.
`value`	field
`source`	field
`context`	method	Returns the context the view carries.
`document`	method	Builds the document tree of the value's current state.
`snapshot`	method	Returns a view of an independent copy of the value.

`binding`field#

binding: core.Binding<T>

@readonly

The binding the view reads its value through.

`value`field#

value: T

@private@readonly

`source`field#

source: core.Context?

@private@readonly

`context`method#

context: function context(self): core.Context?

Returns the context the view carries.

A view made by nupp.serde.document.view carries the context it was given, and a decoded view the context it was read under.

Arguments

Name	Type	Description
`self`	`any`

Returns

Type	Description
`core.Context?`	the context, or nil when the view has none

`document`method#

document: function document(self): documents.Document

Builds the document tree of the value's current state.

Arguments

Name	Type	Description
`self`	`any`

Returns

Type	Description
`documents.Document`	the document, carrying the view's context

`snapshot`method#

snapshot: function snapshot(self): View<T>

Returns a view of an independent copy of the value.

The copy is reconstructed from the value's document through the binding, so later changes to the original do not reach it.

Arguments

Name	Type	Description
`self`	`any`

Returns

Type	Description
`View<T>`	the detached view, with the same binding and context

Raises

Type	Condition
`nupp.serde.Error`	when the binding cannot construct a value from the document it wrote

Functions#

`adapter`function#

function adapter(): core.DocumentAdapter<Document>

Returns the adapter that reads and writes a Document as its contents.

Pass it to a codec's encodeDocument and decodeDocument, or to nupp.serde.adapters.document for a document-valued member.

Returns

Type	Description
`core.DocumentAdapter<Document>`

`atom`function#

function atom(borrows value: core.Atom): Document

A model-defined atom, snapshotted so the document owns it.

Arguments

Name	Type	Description
`borrows value`	`core.Atom`

Returns

Type	Description
`Document`

`bigInteger`function#

function bigInteger(value: string): Document

An integer of unbounded size, from its decimal text.

Arguments

Name	Type	Description
`value`	`string`

Returns

Type	Description
`Document`

`boolean`function#

function boolean(value: boolean): Document

A boolean.

Arguments

Name	Type	Description
`value`	`boolean`

Returns

Type	Description
`Document`

`boundary`function#

function boundary(value: Document): Document

A document boundary around contents, for a document-valued member.

Arguments

Name	Type	Description
`value`	`Document`

Returns

Type	Description
`Document`

`bytes`function#

function bytes(value: string): Document

Binary data.

Arguments

Name	Type	Description
`value`	`string`

Returns

Type	Description
`Document`

`cachedBindings`function#

function cachedBindings(): integer

Returns how many bindings the decoder cache holds.

Returns

Type	Description
`integer`

`clear`function#

function clear(): nil

Empties the decoder cache. Decoders already handed out keep working.

Returns

Type	Description
`nil`

`decimal`function#

function decimal(value: core.Decimal): Document

An exact decimal.

Arguments

Name	Type	Description
`value`	`core.Decimal`

Returns

Type	Description
`Document`

`decoder`function#

function decoder<T>(binding: core.Binding<T>): Decoder<T>

Returns a binding's Decoder, cached by binding identity.

The cache keeps at most 256 bindings and evicts the least recently used.

Type parameters

Name	Description
`T`

Arguments

Name	Type	Description
`binding`	`core.Binding<T>`

Returns

Type	Description
`Decoder<T>`

`float`function#

function float(value: core.Float): Document

A float with its width.

Arguments

Name	Type	Description
`value`	`core.Float`

Returns

Type	Description
`Document`

`from`function#

function from<T>(binding: core.Binding<T>, borrows value: T, context: core.Context?): documents.Document

Converts a bound value to its document.

Type parameters

Name	Description
`T`

Arguments

Name	Type	Description
`binding`	`core.Binding<T>`
`borrows value`	`T`
`context`	`core.Context?`

Returns

Type	Description
`documents.Document`

`integer`function#

function integer(value: core.Integer): Document

A fixed-width integer.

Arguments

Name	Type	Description
`value`	`core.Integer`

Returns

Type	Description
`Document`

`into`function#

function into<T>(binding: core.Binding<T>, value: documents.Document): T

Constructs a bound value from a document.

The binding's construction runs exactly as a decoder's would, so required fields and defaults are checked the same way.

Type parameters

Name	Description
`T`

Arguments

Name	Type	Description
`binding`	`core.Binding<T>`
`value`	`documents.Document`

Returns

Type	Description
`T`

`list`function#

function list(values: {Document}): Document

A list.

Arguments

Name	Type	Description
`values`	`{Document}`

Returns

Type	Description
`Document`

`map`function#

function map(values: {MapEntry}): Document

A map whose keys are documents.

Arguments

Name	Type	Description
`values`	`{MapEntry}`

Returns

Type	Description
`Document`

`null`function#

function null(): Document

A null.

Returns

Type	Description
`Document`

`numberToken`function#

function numberToken(value: string): Document

A number kept as the lexeme it was written as, such as a JSON number too large for any integer width.

Arguments

Name	Type	Description
`value`	`string`

Returns

Type	Description
`Document`

`object`function#

function object(values: {Entry}): Document

A structure, from its members in order.

local document = require("nupp.serde.document")
local json = require("nupp.serde.json")
local value = document.object({
    new document.Entry(name = "ok", value = document.boolean(true)),
    new document.Entry(name = "note", value = document.null())
})
assert(json.encodeDocument(document.adapter(), value) == '{"ok":true,"note":null}')

Arguments

Name	Type	Description
`values`	`{Entry}`

Returns

Type	Description
`Document`

`reader`function#

function reader(value: documents.Document): Reader

Reads a document through the nupp.serde.DocumentReader contract, as a codec's own reader would.

Arguments

Name	Type	Description
`value`	`documents.Document`

Returns

Type	Description
`Reader`

`snapshot`function#

function snapshot(value: documents.Document): documents.Document

Copies a document into one that owns all of its values.

Arguments

Name	Type	Description
`value`	`documents.Document`

Returns

Type	Description
`documents.Document`

`storeBinding`function#

function storeBinding(): core.Binding<Snapshot>

Returns the binding a codec writes and reads a StoreSnapshot through.

Returns

Type	Description
`core.Binding<Snapshot>`

`storeRegistry`function#

function storeRegistry(): Registry

Starts an empty StoreRegistry.

Returns

Type	Description
`Registry`

`string`function#

function string(value: string): Document

A string.

Arguments

Name	Type	Description
`value`	`string`

Returns

Type	Description
`Document`

`timestamp`function#

function timestamp(value: core.Timestamp): Document

A timestamp.

Arguments

Name	Type	Description
`value`	`core.Timestamp`

Returns

Type	Description
`Document`

`tuple`function#

function tuple(values: {Document}): Document

A tuple: a list whose length is part of its shape.

Arguments

Name	Type	Description
`values`	`{Document}`

Returns

Type	Description
`Document`

`union`function#

function union(name: string, value: Document): Document

A union: the one member that is set.

Arguments

Name	Type	Description
`name`	`string`
`value`	`Document`

Returns

Type	Description
`Document`

`view`function#

function view<T is nupp.Copyable>(binding: core.Binding<T>, value: T, context: core.Context?): View<T>

Presents a Copyable value as a View.

Type parameters

Name	Description
`T`

Arguments

Name	Type	Description
`binding`	`core.Binding<T>`
`value`	`T`
`context`	`core.Context?`

Returns

Type	Description
`View<T>`

`viewAdapter`function#

function viewAdapter<T is nupp.Copyable>(binding: core.Binding<T>): core.DocumentAdapter<View<T>>

Returns the document adapter for views of one binding.

Type parameters

Name	Description
`T`

Arguments

Name	Type	Description
`binding`	`core.Binding<T>`

Returns

Type	Description
`core.DocumentAdapter<View<T>>`

`withContext`function#

function withContext(value: Document, context: core.Context): Document

The same document with a context attached.

Arguments

Name	Type	Description
`value`	`Document`
`context`	`core.Context`

Returns

Type	Description
`Document`

nupp.serde.document

Module contents

Types

Functions

Types#

Decoderinterface#

Type parameters

Members

readmethod#

Arguments

Returns

Raises

Documentrecord#

Members

kindfield#

textfield#

flagfield#

timefield#

integerValuefield#

decimalValuefield#

floatValuefield#

atomValuefield#

entriesfield#

elementsfield#

fieldsfield#

sourcefield#

sizemethod#

Arguments

Returns

atmethod#

Arguments

Returns

Raises

getmethod#

Arguments

Returns

stringmethod#

Arguments

Returns

Raises

numberTokenmethod#

Arguments

Returns

Raises

booleanmethod#

Arguments

Returns

Raises

integermethod#

Arguments

Returns

Raises

decimalmethod#

Arguments

Returns

Raises

floatmethod#

Arguments

Returns

Raises

bytesmethod#

Arguments

Returns

Raises

bigIntegermethod#

Arguments

Returns

Raises

timestampmethod#

Arguments

Returns

Raises

atommethod#

Arguments

Returns

Raises

entrymethod#

Arguments

Returns

Raises

`nupp.serde.document`

`Decoder`interface#

`read`method#

`Document`record#

`kind`field#

`text`field#

`flag`field#

`time`field#

`integerValue`field#

`decimalValue`field#

`floatValue`field#

`atomValue`field#

`entries`field#

`elements`field#

`fields`field#

`source`field#

`size`method#

`at`method#

`get`method#

`string`method#

`numberToken`method#

`boolean`method#

`integer`method#

`decimal`method#

`float`method#

`bytes`method#

`bigInteger`method#

`timestamp`method#

`atom`method#

`entry`method#

`field`method#

`document`method#

`context`method#

`Entry`record#

`name`field#

`value`field#

`MapEntry`record#

`key`field#

`value`field#

`Migration`interface#

`apply`method#

`StoreEntry`record#

`name`field#

`version`field#

`value`field#

`StoreRegistry`interface#

`register`method#

`save`method#

`load`method#

`StoreSnapshot`record#

`format`field#

`entries`field#

`View`record#

`binding`field#

`value`field#

`source`field#

`context`method#

`document`method#

`snapshot`method#

`adapter`function#

`atom`function#

`bigInteger`function#