Stdlib module json/builder.vitl

Overview

`json/builder.vitl` is a public stdlib surface inside the `json` family. It should be read as one focused slice of the broader family responsibility: Structured JSON surfaces including parse, parser, types, builder, schema, stringify, and serialize.

Purpose

This file should be chosen because of responsibility, not because its name “sounds close enough”. Inside the json family, it carries one focused part of the contract and keeps that responsibility separate from neighboring concerns.

• A build plan can be validated as domain data first and then exported to JSON in a separate step.
• A parser page should say how syntax becomes JSON values before serialization details appear.

Taxonomy

Think of this page as a generated encyclopedia entry rather than a hand-written tutorial. The goal is to show what kind of module this is, how dense it is, and what reading strategy makes sense before depending on it.

• Medium procedure surface: this file groups several related operations behind one namespace.
• Owns domain vocabulary: the module declares data shapes in addition to executable helpers, so its types are part of the contract.
• Minimal top-level dependencies: the module reads as mostly self-contained from its opening declarations.
• Explicit export surface: the file ends with visible export declarations instead of relying only on implicit namespace discovery.

Implementation profile

This profile is inferred directly from the source text. It does not replace reading the file, but it tells you quickly whether the module is mostly declarative, loop-heavy, branch-heavy, or organized around many small exits.

Top-level API inventory

Imported surfaces

This file does not advertise a top-level `use` surface in its opening declarations. That often means it is either self-contained or an aggregation layer.

Position in family

This file is module 2 of 8 in the json family when ordered by path. By procedure count it ranks 2, and by line count it ranks 2. Those ranks are useful as rough signals of breadth, not as quality judgments.

Declaration map

The declaration map turns raw source into a scan-friendly catalog. It is useful when the file is large enough that a reader wants to orient by kinds of surfaces first.

The table is exhaustive for top-level declarations of the selected kinds. This file declares 21 matching surfaces.

Representative signatures

These signatures are shown in source order so the page keeps the feel of a reference manual, not just a keyword cloud.

• pick JSONValue { (line 7)
• form JSONBuilder { (line 16)
• form JsonBuilderManifest { (line 21)
• proc json_builder_new() -> JSONBuilder { (line 27)
• proc json_builder_append_null(b: JSONBuilder) -> int { (line 34)
• proc json_builder_append_bool(b: JSONBuilder, value: int) -> int { (line 39)
• proc json_builder_append_number(b: JSONBuilder, value: f64) -> int { (line 48)
• proc json_builder_append_string(b: JSONBuilder, value: string) -> int { (line 52)
• proc json_builder_start_object(b: JSONBuilder) -> int { (line 59)
• proc json_builder_end_object(b: JSONBuilder) -> int { (line 65)
• proc json_builder_start_array(b: JSONBuilder) -> int { (line 71)
• proc json_builder_end_array(b: JSONBuilder) -> int { (line 77)
• proc json_builder_append_comma(b: JSONBuilder) -> int { (line 83)
• proc json_builder_append_colon(b: JSONBuilder) -> int { (line 88)
• proc json_builder_to_string(b: JSONBuilder) -> string { (line 93)
• proc json_builder_clear(b: JSONBuilder) { (line 97)
• proc json_builder_version() -> string { (line 102)
• proc json_builder_ready() -> bool { (line 106)

The list is intentionally capped here; the source file declares 20 matching signatures in total.

How to use this module

Start by reading the file as an ownership boundary. Ask three questions: what enters this module, what stable types or procedures it exports, and what adjacent module should stay outside of it.

1. Read space and top-level imports first so the ownership boundary of json/builder.vitl is explicit.
2. Read declared forms and picks before algorithms so the data vocabulary is stable in your head.
3. Traverse procedures in source order; the early helpers usually explain the naming and numeric conventions used later.
4. Use the source landmarks section below as a table of contents when the file is large.
5. Only after that compare neighbor modules, because the right boundary choice matters more than memorizing one helper name.

User example

This example is generated from the actual stdlib module surface. Its job is not to be the smallest snippet possible; its job is to show a realistic consumer-shaped file that exercises the module and mirrors the language keywords the module itself relies on.

space demo/json_builder
form UserReport {
  label: string,
  ready: bool
}
pick UserOutcome {
  case Ready(message: string)
  case Empty(reason: string)
}
proc run_example() -> UserOutcome {
  let result = json_builder_new()
  let ready: bool = json_builder_ready()
  let failed: bool = false
  let stable: bool = ready and true
  if ready {
    give UserOutcome.Empty("module not ready")
  } else {
    give UserOutcome.Ready("ok")
  }
}
export run_example

Keyword coverage

This table makes the “all keywords of the module” requirement auditable. It compares the detected Vitte keywords in the source file with the generated consumer example above.

The generated snippet exercises every detected Vitte keyword used by this module.

Source shape

space vitte/json/builder
pick JSONValue {
  JsonNull,
  JsonBool(value: int),
  JsonNumber(value: f64),
  JsonString(value: string),
  JsonArray(items: [JSONValue]),
  JsonObject(keys: [string])
}
form JSONBuilder {

The excerpt is not meant to replace the file. It exists to make the module recognizable at first glance, the same way a Wikipedia infobox helps the reader orient before reading the whole article.

Source landmarks

Large files are easier to retain when they have visible landmarks. When the source contains explicit section banners, they are surfaced here; otherwise the first major declarations are used as anchors.

• JSON Builder Module

Source organization

When a file carries its own internal chaptering, those chapters usually reveal the intended reading order better than a flat symbol list. This section reconstructs that organization from the source itself.

Complete API catalog

This catalog is the exhaustive file-level index for the module. It is intentionally closer to a generated encyclopedia appendix than to a tutorial summary.

Data surfaces

Procedures

Exports

Integration boundaries

Within json, this file should remain focused. If a future helper changes the host boundary, scheduling boundary, or data-shape boundary, it probably belongs in a neighbor module instead of being added here by convenience.

• Family responsibility: Structured JSON surfaces including parse, parser, types, builder, schema, stringify, and serialize.
• Family architecture role: Use `json` when data must cross a structured textual boundary. This family owns JSON shape and conversion, not business validation itself.

Composition guidance

Choose this module when

• Choose json/builder.vitl when the main question is owned by this module rather than by transport, storage, orchestration, or user-interface code.
• A build plan can be validated as domain data first and then exported to JSON in a separate step.
• A parser page should say how syntax becomes JSON values before serialization details appear.

Pause before extending it when

• Avoid extending this file when the new helper mostly changes the boundary to host I/O, runtime coordination, or foreign integration instead of staying inside json.
• Check nearby modules such as json/parse.vitl, json/parser.vitl, json/schema.vitl before adding convenience wrappers here.

Relationship table

This table keeps the page closer to a real encyclopedia entry: a module is easier to understand when compared with its nearest alternatives in the same family.

Neighbor modules

• json/parse.vitl
• json/parser.vitl
• json/schema.vitl
• json/serialize.vitl
• json/stringify.vitl
• json/types.vitl
• json.vitl