Stdlib module io/host_runtime.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/host_runtime.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/host_runtime.vitl |
| Family | io |
| Kind | public stdlib surface |
| Line count | 106 |
| Declared procedures | 17 |
| Declared forms/picks | 0 |
`io/host_runtime.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.
- 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 | 17 | Number of explicit exit points and result shaping. |
Top-level API inventory
| Surface | Items |
|---|---|
| Procedures | host_runtime_available, host_read_file, host_write_file, host_append_file, host_file_exists, host_is_file, host_is_directory, host_mkdir_all, host_delete_file, host_copy_file, host_move_file, host_delete_directory |
| Forms | none declared at top level |
| Picks | none declared at top level |
| Constants | none declared at top level |
| 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 5 of 8 in the io family when ordered by path. By procedure count it ranks 6, and by line count it ranks 6. 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/io/host_runtime | space | Declares the namespace that anchors this file in the stdlib tree. |
| 22 | host_runtime_available | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 26 | host_read_file | proc | Owns byte movement or host I/O interaction. |
| 30 | host_write_file | proc | Owns byte movement or host I/O interaction. |
| 34 | host_append_file | proc | Owns byte movement or host I/O interaction. |
| 38 | host_file_exists | proc | Owns byte movement or host I/O interaction. |
| 42 | host_is_file | proc | Owns byte movement or host I/O interaction. |
| 46 | host_is_directory | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 50 | host_mkdir_all | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 54 | host_delete_file | proc | Owns byte movement or host I/O interaction. |
| 58 | host_copy_file | proc | Owns byte movement or host I/O interaction. |
| 62 | host_move_file | proc | Owns byte movement or host I/O interaction. |
| 66 | host_delete_directory | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 70 | host_list_directory | proc | Owns a concrete data shape or the operations that maintain it. |
| 74 | host_system | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 78 | host_emit_llvm_object | proc | Turns internal values into a transport or textual representation. |
| 82 | host_link_executable | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 86 | host_run_executable | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
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.
proc host_runtime_available() -> bool {(line 22)proc host_read_file(path: string) -> string {(line 26)proc host_write_file(path: string, content: string) -> int {(line 30)proc host_append_file(path: string, content: string) -> int {(line 34)proc host_file_exists(path: string) -> bool {(line 38)proc host_is_file(path: string) -> bool {(line 42)proc host_is_directory(path: string) -> bool {(line 46)proc host_mkdir_all(path: string) -> int {(line 50)proc host_delete_file(path: string) -> int {(line 54)proc host_copy_file(src: string, dst: string) -> int {(line 58)proc host_move_file(src: string, dst: string) -> int {(line 62)proc host_delete_directory(path: string) -> int {(line 66)proc host_list_directory(path: string) -> [string] {(line 70)proc host_system(command: string) -> int {(line 74)proc host_emit_llvm_object(ir_text: string, object_path: string) -> int {(line 78)proc host_link_executable(object_path: string, executable_path: string) -> int {(line 82)proc host_run_executable(executable_path: string) -> int {(line 86)
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/host_runtime.vitlis explicit. - 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_host_runtime
proc run_example() -> string {
give "ok"
}
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 |
proc | yes | yes |
give | yes | yes |
The generated snippet exercises every detected Vitte keyword used by this module.
Source shape
space vitte/stdlib/io/host_runtime
// Native host ABI. The runtime_c implementation is linked into native tools.
intrinsic vitte_host_runtime_available() -> bool;
intrinsic vitte_host_read_file(path: string) -> string;
intrinsic vitte_host_write_file(path: string, content: string) -> int;
intrinsic vitte_host_append_file(path: string, content: string) -> int;
intrinsic vitte_host_file_exists(path: string) -> bool;
intrinsic vitte_host_is_file(path: string) -> bool;
intrinsic vitte_host_is_directory(path: string) -> bool;
intrinsic vitte_host_mkdir_all(path: string) -> 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/io/host_runtime - Line 22:
proc host_runtime_available() -> bool { - Line 26:
proc host_read_file(path: string) -> string { - Line 30:
proc host_write_file(path: string, content: string) -> int { - Line 34:
proc host_append_file(path: string, content: string) -> int { - Line 38:
proc host_file_exists(path: string) -> bool { - Line 42:
proc host_is_file(path: string) -> bool { - Line 46:
proc host_is_directory(path: string) -> bool {
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: 18. Procedures: 17. Data surfaces: 0. Constants: 0.
First visible names: vitte/stdlib/io/host_runtime, host_runtime_available, host_read_file, host_write_file, host_append_file, host_file_exists, host_is_file, host_is_directory, host_mkdir_all, host_delete_file
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.
Procedures
| Line | Name | Signature | Role |
|---|---|---|---|
| 22 | host_runtime_available | proc host_runtime_available() -> bool { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 26 | host_read_file | proc host_read_file(path: string) -> string { | Owns byte movement or host I/O interaction. |
| 30 | host_write_file | proc host_write_file(path: string, content: string) -> int { | Owns byte movement or host I/O interaction. |
| 34 | host_append_file | proc host_append_file(path: string, content: string) -> int { | Owns byte movement or host I/O interaction. |
| 38 | host_file_exists | proc host_file_exists(path: string) -> bool { | Owns byte movement or host I/O interaction. |
| 42 | host_is_file | proc host_is_file(path: string) -> bool { | Owns byte movement or host I/O interaction. |
| 46 | host_is_directory | proc host_is_directory(path: string) -> bool { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 50 | host_mkdir_all | proc host_mkdir_all(path: string) -> int { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 54 | host_delete_file | proc host_delete_file(path: string) -> int { | Owns byte movement or host I/O interaction. |
| 58 | host_copy_file | proc host_copy_file(src: string, dst: string) -> int { | Owns byte movement or host I/O interaction. |
| 62 | host_move_file | proc host_move_file(src: string, dst: string) -> int { | Owns byte movement or host I/O interaction. |
| 66 | host_delete_directory | proc host_delete_directory(path: string) -> int { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 70 | host_list_directory | proc host_list_directory(path: string) -> [string] { | Owns a concrete data shape or the operations that maintain it. |
| 74 | host_system | proc host_system(command: string) -> int { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 78 | host_emit_llvm_object | proc host_emit_llvm_object(ir_text: string, object_path: string) -> int { | Turns internal values into a transport or textual representation. |
| 82 | host_link_executable | proc host_link_executable(object_path: string, executable_path: string) -> int { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 86 | host_run_executable | proc host_run_executable(executable_path: string) -> int { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
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/host_runtime.vitlwhen 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/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/io.vitl | 41 | 0 | Shares the same family boundary but carries a distinct slice of responsibility. |
io/stdio.vitl | 35 | 4 | 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. |