Stdlib module io/stdio.vitl
This page is a wiki-style reference for one concrete stdlib file. It explains what the file owns, where it fits in the family, and how to decide whether this is the right surface to depend on.
io/stdio.vitl.Family: io
Kind: public stdlib surface
Page style: this reference follows the same “encyclopedic card + portrait + usage contract” logic as the keyword pages, but for stdlib modules.
Summary
- Overview
- Purpose
- Taxonomy
- Implementation profile
- Top-level API inventory
- Position in family
- Declaration map
- Representative signatures
- How to use this module
- User example
- Keyword coverage
- Source shape
- Source landmarks
- Source organization
- Complete API catalog
- Integration boundaries
- Composition guidance
- Relationship table
- Neighbor modules
Overview
| Field | Value |
|---|---|
| Path | io/stdio.vitl |
| Family | io |
| Kind | public stdlib surface |
| Line count | 179 |
| Declared procedures | 35 |
| Declared forms/picks | 4 |
`io/stdio.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.
- Use this module when bytes or paths cross a host boundary and architecture must keep that boundary visible.
- 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.
- Large algorithm surface: this file exposes many procedures and likely acts as a domain toolkit rather than a single thin wrapper.
- Owns domain vocabulary: the module declares data shapes in addition to executable helpers, so its types are part of the contract.
- 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.
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.
| Signal | Count | What it suggests |
|---|---|---|
if | 0 | Branching density and local decision-making. |
while | 0 | Loop-heavy or iterative implementation style. |
for | 0 | Collection-style traversal at source level. |
match | 0 | Variant-driven branching or grammar-style decoding. |
let | 0 | Local state and intermediate value density. |
give | 35 | Number of explicit exit points and result shaping. |
Top-level API inventory
| Surface | Items |
|---|---|
| Procedures | _process_format, printf, stdio_version, stdio_ready, stdio_manifest, stdio_health, stdio_summary, fprintf, sprintf, puts, fputs, putchar |
| Forms | StdioManifest, StdioHealth, StdioSummary, File |
| Picks | none declared at top level |
| Constants | stdin, stdout, stderr, EOF, NULL_PTR, _IOFBF, _IOLBF, _IONBF |
| Exports | none declared at top level |
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 7 of 8 in the io family when ordered by path. By procedure count it ranks 3, and by line count it ranks 3. 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.
| Line | Name | Kind | Role |
|---|---|---|---|
| 1 | vitte/stdlib_checked/io_stdio | space | Declares the namespace that anchors this file in the stdlib tree. |
| 9 | StdioManifest | form | Introduces a structured data shape that other procedures can exchange. |
| 13 | StdioHealth | form | Introduces a structured data shape that other procedures can exchange. |
| 17 | StdioSummary | form | Introduces a structured data shape that other procedures can exchange. |
| 21 | File | form | Introduces a structured data shape that other procedures can exchange. |
| 25 | stdin | const | Defines a named constant reused across the module. |
| 27 | stdout | const | Defines a named constant reused across the module. |
| 29 | stderr | const | Defines a named constant reused across the module. |
| 31 | EOF | const | Defines a named constant reused across the module. |
| 33 | NULL_PTR | const | Defines a named constant reused across the module. |
| 35 | _process_format | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 39 | printf | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 43 | stdio_version | proc | Owns byte movement or host I/O interaction. |
| 47 | stdio_ready | proc | Owns byte movement or host I/O interaction. |
| 51 | stdio_manifest | proc | Owns byte movement or host I/O interaction. |
| 55 | stdio_health | proc | Owns byte movement or host I/O interaction. |
| 59 | stdio_summary | proc | Owns byte movement or host I/O interaction. |
| 63 | fprintf | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 67 | sprintf | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 71 | puts | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 75 | fputs | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 79 | putchar | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 83 | putc | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 87 | print_int | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 91 | print_float | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 95 | print_string | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 99 | println | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 103 | scanf | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 107 | fscanf | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 111 | sscanf | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 115 | gets | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 119 | fgets | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 123 | getchar | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 127 | getc | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 131 | read_int | proc | Owns byte movement or host I/O interaction. |
| 135 | read_float | proc | Owns byte movement or host I/O interaction. |
| 139 | read_string | proc | Owns byte movement or host I/O interaction. |
| 143 | stdio_selftest | proc | Owns byte movement or host I/O interaction. |
| 147 | ungetc | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 151 | getline | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 155 | perror | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 159 | setbuf | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 163 | setvbuf | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 167 | _IOFBF | const | Defines a named constant reused across the module. |
| 169 | _IOLBF | const | Defines a named constant reused across the module. |
| 171 | _IONBF | const | Defines a named constant reused across the module. |
| 173 | __write | proc | Owns byte movement or host I/O interaction. |
| 177 | __read | proc | Owns byte movement or host I/O interaction. |
The table is exhaustive for top-level declarations of the selected kinds. This file declares 48 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 StdioManifest {(line 9)form StdioHealth {(line 13)form StdioSummary {(line 17)form File {(line 21)const stdin: int = 0(line 25)const stdout: int = 0(line 27)const stderr: int = 0(line 29)const EOF: int = 0(line 31)const NULL_PTR: int = 0(line 33)proc _process_format() -> int {(line 35)proc printf() -> int {(line 39)proc stdio_version() -> int {(line 43)proc stdio_ready() -> int {(line 47)proc stdio_manifest() -> int {(line 51)proc stdio_health() -> int {(line 55)proc stdio_summary() -> int {(line 59)proc fprintf() -> int {(line 63)proc sprintf() -> int {(line 67)
The list is intentionally capped here; the source file declares 47 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.
- Read
spaceand top-level imports first so the ownership boundary ofio/stdio.vitlis explicit. - Scan constants before procedures; they often encode precision, limits, or policy assumptions that explain later behavior.
- Read declared forms and picks before algorithms so the data vocabulary is stable in your head.
- Traverse procedures in source order; the early helpers usually explain the naming and numeric conventions used later.
- 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_stdio
const SAMPLE_LABEL: string = "demo"
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.
| Keyword | Present in module source | Used in generated user example |
|---|---|---|
space | yes | yes |
const | yes | yes |
form | yes | yes |
proc | yes | yes |
give | yes | yes |
The generated snippet exercises every detected Vitte keyword used by this module.
Source shape
space vitte/stdlib_checked/io_stdio
form StdioManifest {
value: int
}
form StdioHealth {
value: int
}
form StdioSummary {
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_stdio - Line 9:
form StdioManifest { - Line 13:
form StdioHealth { - Line 17:
form StdioSummary { - Line 21:
form File { - Line 25:
const stdin: int = 0 - Line 27:
const stdout: int = 0 - Line 29:
const stderr: int = 0
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.
File surfaces
Top-level items: 48. Procedures: 35. Data surfaces: 4. Constants: 8.
First visible names: vitte/stdlib_checked/io_stdio, StdioManifest, StdioHealth, StdioSummary, File, stdin, stdout, stderr, EOF, NULL_PTR
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
| Line | Name | Signature | Role |
|---|---|---|---|
| 25 | stdin | const stdin: int = 0 | Defines a named constant reused across the module. |
| 27 | stdout | const stdout: int = 0 | Defines a named constant reused across the module. |
| 29 | stderr | const stderr: int = 0 | Defines a named constant reused across the module. |
| 31 | EOF | const EOF: int = 0 | Defines a named constant reused across the module. |
| 33 | NULL_PTR | const NULL_PTR: int = 0 | Defines a named constant reused across the module. |
| 167 | _IOFBF | const _IOFBF: i32 = 0 | Defines a named constant reused across the module. |
| 169 | _IOLBF | const _IOLBF: i32 = 0 | Defines a named constant reused across the module. |
| 171 | _IONBF | const _IONBF: i32 = 0 | Defines a named constant reused across the module. |
Data surfaces
| Line | Name | Signature | Role |
|---|---|---|---|
| 9 | StdioManifest | form StdioManifest { | Introduces a structured data shape that other procedures can exchange. |
| 13 | StdioHealth | form StdioHealth { | Introduces a structured data shape that other procedures can exchange. |
| 17 | StdioSummary | form StdioSummary { | Introduces a structured data shape that other procedures can exchange. |
| 21 | File | form File { | Introduces a structured data shape that other procedures can exchange. |
Procedures
| Line | Name | Signature | Role |
|---|---|---|---|
| 35 | _process_format | proc _process_format() -> int { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 39 | printf | proc printf() -> int { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 43 | stdio_version | proc stdio_version() -> int { | Owns byte movement or host I/O interaction. |
| 47 | stdio_ready | proc stdio_ready() -> int { | Owns byte movement or host I/O interaction. |
| 51 | stdio_manifest | proc stdio_manifest() -> int { | Owns byte movement or host I/O interaction. |
| 55 | stdio_health | proc stdio_health() -> int { | Owns byte movement or host I/O interaction. |
| 59 | stdio_summary | proc stdio_summary() -> int { | Owns byte movement or host I/O interaction. |
| 63 | fprintf | proc fprintf() -> int { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 67 | sprintf | proc sprintf() -> int { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 71 | puts | proc puts() -> int { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 75 | fputs | proc fputs() -> int { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 79 | putchar | proc putchar() -> int { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 83 | putc | proc putc() -> int { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 87 | print_int | proc print_int() -> int { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 91 | print_float | proc print_float() -> int { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 95 | print_string | proc print_string() -> int { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 99 | println | proc println() -> int { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 103 | scanf | proc scanf() -> int { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 107 | fscanf | proc fscanf() -> int { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 111 | sscanf | proc sscanf() -> int { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 115 | gets | proc gets() -> int { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 119 | fgets | proc fgets() -> int { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 123 | getchar | proc getchar() -> int { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 127 | getc | proc getc() -> int { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 131 | read_int | proc read_int() -> int { | Owns byte movement or host I/O interaction. |
| 135 | read_float | proc read_float() -> int { | Owns byte movement or host I/O interaction. |
| 139 | read_string | proc read_string() -> int { | Owns byte movement or host I/O interaction. |
| 143 | stdio_selftest | proc stdio_selftest() -> int { | Owns byte movement or host I/O interaction. |
| 147 | ungetc | proc ungetc() -> int { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 151 | getline | proc getline() -> int { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 155 | perror | proc perror() -> int { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 159 | setbuf | proc setbuf() -> int { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 163 | setvbuf | proc setvbuf() -> int { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 173 | __write | proc __write() -> int { | Owns byte movement or host I/O interaction. |
| 177 | __read | proc __read() -> int { | Owns byte movement or host I/O interaction. |
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/stdio.vitlwhen the main question is owned by this module rather than by transport, storage, orchestration, or user-interface code. - Use this module when bytes or paths cross a host boundary and architecture must keep that boundary visible.
- 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/buffer.vitl,io/file.vitl,io/fileops.vitlbefore 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 | Procedures | Data surfaces | Why compare it |
|---|---|---|---|
io/buffer.vitl | 13 | 4 | Shares the same family boundary but carries a distinct slice of responsibility. |
io/file.vitl | 23 | 4 | Shares the same family boundary but carries a distinct slice of responsibility. |
io/fileops.vitl | 19 | 3 | Shares the same family boundary but carries a distinct slice of responsibility. |
io/host_runtime.vitl | 17 | 0 | Shares the same family boundary but carries a distinct slice of responsibility. |
io/io.vitl | 41 | 0 | Shares the same family boundary but carries a distinct slice of responsibility. |
io/stream.vitl | 13 | 4 | Shares the same family boundary but carries a distinct slice of responsibility. |
io.vitl | 132 | 12 | Shares the same family boundary but carries a distinct slice of responsibility. |