Stdlib module io/buffer.vitl

Overview

`io/buffer.vitl` is a public stdlib surface inside the `io` family. It should be read as one focused slice of the broader family responsibility: File, buffer, stream, stdio, and host-runtime access helpers.

Purpose

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

• A manifest is loaded through `io`, parsed elsewhere, validated elsewhere, and only then emitted back through `io`.
• A stdio helper should explain where user-facing text enters the flow.

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.

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 io family when ordered by path. By procedure count it ranks 7, and by line count it ranks 7. 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 18 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.

• form Buffer { (line 9)
• form BufferManifest { (line 13)
• form BufferHealth { (line 17)
• form BufferSummary { (line 21)
• proc buffer_create() -> int { (line 25)
• proc buffer_version() -> int { (line 29)
• proc buffer_ready() -> int { (line 33)
• proc buffer_manifest() -> int { (line 37)
• proc buffer_health() -> int { (line 41)
• proc buffer_summary() -> int { (line 45)
• proc buffer_write() -> int { (line 49)
• proc buffer_read() -> int { (line 53)
• proc buffer_peek() -> int { (line 57)
• proc buffer_skip() -> int { (line 61)
• proc buffer_clear() -> int { (line 65)
• proc buffer_remaining() -> int { (line 69)
• proc buffer_selftest() -> int { (line 73)

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 io/buffer.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. 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/io_buffer
form UserReport {
  label: string,
  ready: bool
}
proc run_example() -> UserReport {
    give UserReport { label: "ok", ready: ready }
}

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/stdlib_checked/io_buffer
form Buffer {
  value: int
}
form BufferManifest {
  value: int
}
form BufferHealth {
  value: int
}

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.

• Line 1: space vitte/stdlib_checked/io_buffer
• Line 9: form Buffer {
• Line 13: form BufferManifest {
• Line 17: form BufferHealth {
• Line 21: form BufferSummary {
• Line 25: proc buffer_create() -> int {
• Line 29: proc buffer_version() -> int {
• Line 33: proc buffer_ready() -> int {

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

Integration boundaries

Within io, 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: File, buffer, stream, stdio, and host-runtime access helpers.
• Family architecture role: Use `io` when the program must read or write bytes, files, or streams. Keep it separate from validation, parsing, or business decisions.

Composition guidance

Choose this module when

• Choose io/buffer.vitl when the main question is owned by this module rather than by transport, storage, orchestration, or user-interface code.
• A manifest is loaded through `io`, parsed elsewhere, validated elsewhere, and only then emitted back through `io`.
• A stdio helper should explain where user-facing text enters the flow.

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 io.
• Check nearby modules such as io/file.vitl, io/fileops.vitl, io/host_runtime.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

• io/file.vitl
• io/fileops.vitl
• io/host_runtime.vitl
• io/io.vitl
• io/stdio.vitl
• io/stream.vitl
• io.vitl