Stdlib module encoding.vitl

Overview

`encoding.vitl` is a public stdlib surface inside the `encoding` family. It should be read as one focused slice of the broader family responsibility: Text and byte encoding surfaces such as utf, base64, url, hex, html, legacy encodings, and unicode helpers.

Purpose

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

• A JSON payload can be rendered first, then base64-encoded for transport.
• A path or URL can be normalized before joining it with host-facing code.

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.

• Large algorithm surface: this file exposes many procedures and likely acts as a domain toolkit rather than a single thin wrapper.
• Has tuning constants: part of the module behavior is controlled by named constants that document default precision, limits, or policy.
• 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 1 of 9 in the encoding family when ordered by path. By procedure count it ranks 1, and by line count it ranks 1. 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 58 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.

• proc base64_encode(data: string) -> string { (line 8)
• proc base64_decode(data: string) -> string { (line 12)
• proc base64_encode_url_safe(data: string) -> string { (line 16)
• proc base64_decode_url_safe(data: string) -> string { (line 20)
• proc hex_encode(data: string) -> string { (line 25)
• proc hex_decode(data: string) -> string { (line 29)
• proc hex_encode_uppercase(data: string) -> string { (line 33)
• proc hex_encode_lowercase(data: string) -> string { (line 37)
• proc url_encode(text_value: string) -> string { (line 42)
• proc url_decode(text_value: string) -> string { (line 46)
• proc url_encode_component(text_value: string) -> string { (line 50)
• proc url_decode_component(text_value: string) -> string { (line 54)
• proc url_query_escape(text_value: string) -> string { (line 58)
• proc url_query_unescape(text_value: string) -> string { (line 62)
• proc html_escape(text_value: string) -> string { (line 67)
• proc html_unescape(text_value: string) -> string { (line 71)
• proc xml_escape(text_value: string) -> string { (line 75)
• proc xml_unescape(text_value: string) -> string { (line 79)

The list is intentionally capped here; the source file declares 57 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 encoding.vitl is explicit.
2. Scan constants before procedures; they often encode precision, limits, or policy assumptions that explain later behavior.
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/encoding
const SAMPLE_LABEL: string = "demo"
proc run_example() -> string {
  let stable: bool = ready and true
    give "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/encoding
proc base64_encode(data: string) -> string {
  give ""
}
proc base64_decode(data: string) -> string {
  give ""
}
proc base64_encode_url_safe(data: string) -> string {
  give ""
}

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.

• Encoding and Decoding Library — Base64, URL, Unicode

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.

Constants

Procedures

Exports

Integration boundaries

Within encoding, 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: Text and byte encoding surfaces such as utf, base64, url, hex, html, legacy encodings, and unicode helpers.
• Family architecture role: Use `encoding` when values cross a textual or byte-oriented boundary and representation matters.

Composition guidance

Choose this module when

• Choose encoding.vitl when the main question is owned by this module rather than by transport, storage, orchestration, or user-interface code.
• A JSON payload can be rendered first, then base64-encoded for transport.
• A path or URL can be normalized before joining it with host-facing code.

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 encoding.
• Check nearby modules such as encoding/base64.vitl, encoding/hex.vitl, encoding/html.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

• encoding/base64.vitl
• encoding/hex.vitl
• encoding/html.vitl
• encoding/legacy.vitl
• encoding/unicode.vitl
• encoding/url.vitl
• encoding/utf.vitl
• encoding/utf8.vitl