Building documents

These operations construct a document one node at a time. For most operations, parse a document in your selected format. Use these operations only when you cannot parse the document from text.

Create a builder.
Add the nodes in preorder.
Seal the builder to create an owned document.

Operations

Operation	Returns	Summary
builder	builder	Create an owned document builder.
add	node	builder.add(node) appends one node and returns its preorder ID.
add-many	none	builder.add_many(nodes) appends nodes in order in one native call.
seal	document	builder.seal() transfers the constructed document into an independent owned document.
close	none	Release the builder handle.

builder

clojure

2 B

[]

clojure

9 B

[options]

Parameters

Parameter	Type	Ownership	Default	Meaning
`options`	`map`	Value	{}	Binding options map. The :library key selects the loaded native library. Omission uses the binding's default library.

Errors

Status	When
`:out-of-memory`	native memory is exhausted

Notes

Add nodes in depth-first preorder. An append failure makes the builder unusable.

Examples

builder

clojure

176 B

(with-open [builder (sd/builder)]
  (let [object (sd/add builder {:kind :object})]
    (sd/add builder {:parent object :kind :number :key "x" :number 41}))
  (sd/seal builder))

TRON

33 B

Offset (hex)	Bytes (hex)	Meaning
00	54 52 4F 4E	magic TRON
04	1C 78	txt "x"
06	02 29000000000000 00	i64 41
0F	0F 0A 04000000 0600 0000	map leaf, size 10: @4 → @6
19	0F000000 00000000	root → @F; previous: none

C exports: stardust_document_builder_create

add

clojure

14 B

[builder node]

Requires exclusive use of the receiver handle.

Parameters

Parameter	Type	Ownership	Default	Meaning
`builder`	`Builder`	Borrowed for the call	Required	The builder owner for this operation. Keep it alive during the call.
`node`	`node-input`	Value	Required	The next node's kind, parent and typed value.

Errors

Status	When
`:invalid-argument`	the node breaks the preorder rules or has an invalid kind or number
`:closed`	the builder is closed
`:out-of-memory`	native memory is exhausted

Notes

The root has no parent. Each later parent must be an open container or one of its ancestors.

Examples

builder/add

clojure

176 B

(with-open [builder (sd/builder)]
  (let [object (sd/add builder {:kind :object})]
    (sd/add builder {:parent object :kind :number :key "x" :number 41}))
  (sd/seal builder))

TRON

33 B

Offset (hex)	Bytes (hex)	Meaning
00	54 52 4F 4E	magic TRON
04	1C 78	txt "x"
06	02 29000000000000 00	i64 41
0F	0F 0A 04000000 0600 0000	map leaf, size 10: @4 → @6
19	0F000000 00000000	root → @F; previous: none

Add a typed integer node

clojure

156 B

(let [input {:parent nil :kind :number :number 41 :boolean false :key "" :text ""}]
  (with-open [builder (sd/builder)]
    (sd/add builder input))
  input)

TRON

158 B

Offset (hex)	Bytes (hex)	Meaning
00	54 52 4F 4E	magic TRON
04	3C 6B6579	txt "key"
08	0C	txt ""
09	0F 0A 04000000 0800 0000	map leaf, size 10: @4 → @8
13	4C 6B696E64	txt "kind"
18	6C 6E756D626572	txt "number"
1F	0F 0A 13000000 1800 0000	map leaf, size 10: @13 → @18
29	6C 6E756D626572	txt "number"
30	02 29000000000000 00	i64 41
39	0F 0A 29000000 3000 0000	map leaf, size 10: @29 → @30
43	6C 706172656E74	txt "parent"
4A	00	nil
4B	0F 0A 43000000 4A00 0000	map leaf, size 10: @43 → @4A
55	4C 74657874	txt "text"
5A	0C	txt ""
5B	0F 0A 55000000 5A00 0000	map leaf, size 10: @55 → @5A
65	7C 626F6F6C65616E	txt "boolean"
6D	01	bit false
6E	0F 0A 65000000 6D00 0000	map leaf, size 10: @65 → @6D
78	07 1E A1190000 0900 0000 1F000000 3900 0000 4B000000 5B00 0000 6E000000	map branch, size 30, depth 0 (root), slots 0, 5, 7, 8, 11, 12: @9 → @1F → @39 → @4B → @5B → @6E
96	78000000 00000000	root → @78; previous: none

C exports: stardust_document_builder_add_many, stardust_document_builder_error

add-many

clojure

15 B

[builder nodes]

Requires exclusive use of the receiver handle.

Parameters

Parameter	Type	Ownership	Default	Meaning
`builder`	`Builder`	Borrowed for the call	Required	The builder owner for this operation. Keep it alive during the call.
`nodes`	`Node_Inputs`	Value	Required	Nodes in depth-first preorder to append together.

Errors

Status	When
`:invalid-argument`	a node breaks the preorder rules or has an invalid kind or number
`:closed`	the builder is closed
`:out-of-memory`	native memory is exhausted

Examples

builder/add_many

clojure

142 B

(with-open [builder (sd/builder)]
  (sd/add-many builder [{:kind :object} {:parent 0 :kind :number :key "x" :number 41}])
  (sd/seal builder))

TRON

33 B

Offset (hex)	Bytes (hex)	Meaning
00	54 52 4F 4E	magic TRON
04	1C 78	txt "x"
06	02 29000000000000 00	i64 41
0F	0F 0A 04000000 0600 0000	map leaf, size 10: @4 → @6
19	0F000000 00000000	root → @F; previous: none

C exports: stardust_document_builder_add_many, stardust_document_builder_error

seal

clojure

9 B

[builder]

Requires exclusive use of the receiver handle.

Parameters

Parameter	Type	Ownership	Default	Meaning
`builder`	`Builder`	Borrowed for the call	Required	The builder owner for this operation. Keep it alive during the call.

Errors

Status	When
`:invalid-argument`	the builder has no root or a container is still open
`:closed`	the builder is closed
`:out-of-memory`	native memory is exhausted

Notes

The builder accepts no more nodes after sealing.

Examples

builder/seal

clojure

176 B

(with-open [builder (sd/builder)]
  (let [object (sd/add builder {:kind :object})]
    (sd/add builder {:parent object :kind :number :key "x" :number 41}))
  (sd/seal builder))

TRON

33 B

Offset (hex)	Bytes (hex)	Meaning
00	54 52 4F 4E	magic TRON
04	1C 78	txt "x"
06	02 29000000000000 00	i64 41
0F	0F 0A 04000000 0600 0000	map leaf, size 10: @4 → @6
19	0F000000 00000000	root → @F; previous: none

C exports: stardust_document_builder_seal, stardust_document_builder_error

close

clojure

8 B

[handle]

Consumes the receiver handle.

Parameters

Parameter	Type	Ownership	Default	Meaning
`handle`	`Builder`	Consumed owner	Required	The builder owner to release. Do not use it after this call.

Examples

builder/close

input-text holds this document:

TRON

33 B

Offset (hex)	Bytes (hex)	Meaning
00	54 52 4F 4E	magic TRON
04	1C 78	txt "x"
06	02 29000000000000 00	i64 41
0F	0F 0A 04000000 0600 0000	map leaf, size 10: @4 → @6
19	0F000000 00000000	root → @F; previous: none

clojure

79 B

(let [builder (sd/builder)]
  (sd/close builder)
  (sd/parse input-text :tron))

TRON

33 B

Offset (hex)	Bytes (hex)	Meaning
00	54 52 4F 4E	magic TRON
04	1C 78	txt "x"
06	02 29000000000000 00	i64 41
0F	0F 0A 04000000 0600 0000	map leaf, size 10: @4 → @6
19	0F000000 00000000	root → @F; previous: none

C exports: stardust_document_builder_release