Stdlib module mod.vit

Overview

`mod.vit` is a aggregation module inside the `stdlib` family. It should be read as one focused slice of the broader family responsibility: Top-level map of the Vitte standard library and the responsibilities owned by each family.

Purpose

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

• Domain values start in `core` and `strings`.
• Grouped data moves through `collections` or `data`.
• Structured export goes through `json` and `encoding`.
• Filesystem or process interaction goes through `path`, `io`, `os`, or `sysinfo`.
• Explicit runtime coordination goes through `async`, `threading`, `kernel`, or `ffi`.

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.
• Narrow dependency fan-in: a small set of imports suggests a focused collaboration surface.
• Explicit export surface: the file ends with visible export declarations instead of relying only on implicit namespace discovery.
• Aggregation-oriented module: this file likely collects exports and family-level entry points more than it implements novel algorithms.

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

• vitte/stdlib/collections as coll use vitte/stdlib/io as io use vitte/stdlib/io/fileops.{ append_file, copy_file, create_directory, delete_directory, delete_file, file_exists, is_directory, is_file, list_directory, move_file, read_file, write_file } form Vector

Position in family

This file is module 6 of 15 in the stdlib family when ordered by path. By procedure count it ranks 9, and by line count it ranks 9. 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 22 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 Vector<T> { (line 7)
• form HashMap<K, V> { (line 11)
• proc vector_new<T>() -> Vector<T> { (line 15)
• proc vector_push<T>(vec: Vector<T>, item: T) -> Vector<T> { (line 19)
• proc hashmap_new<K, V>() -> HashMap<K, V> { (line 23)
• proc hashmap_insert<K, V>(map: HashMap<K, V>, key: K, value: V) -> HashMap<K, V> { (line 27)
• proc io_read_file(path: string) -> string { (line 31)
• proc io_write_file(path: string, content: string) -> bool { (line 35)
• proc io_append_file(path: string, content: string) -> bool { (line 39)
• proc io_file_exists(path: string) -> bool { (line 43)
• proc io_create_directory(path: string) -> bool { (line 47)
• proc io_is_file(path: string) -> bool { (line 51)
• proc io_is_directory(path: string) -> bool { (line 55)
• proc io_copy_file(src: string, dst: string) -> bool { (line 59)
• proc io_move_file(src: string, dst: string) -> bool { (line 63)
• proc io_delete_file(path: string) -> bool { (line 67)
• proc io_delete_directory(path: string) -> bool { (line 71)
• proc io_list_directory(path: string) -> [string] { (line 75)

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 mod.vit 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/mod
use vitte/stdlib/mod
form DemoState {
  ready: bool,
  note: string
}
proc run_example() -> DemoState {
  let values = vector_push<int>(vector_new<int>(), 1)
  let ready: bool = io_file_exists("README.md") or values.data.len >= 0
  let count_f64: f64 = values.data.len as f64
  give DemoState { ready: ready, note: "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/stdlib/mod
use vitte/stdlib/collections as coll
use vitte/stdlib/io as io
use vitte/stdlib/io/fileops.{ append_file, copy_file, create_directory, delete_directory, delete_file, file_exists, is_directory, is_file, list_directory, move_file, read_file, write_file }
form Vector<T> {
  data: [T],
}
form HashMap<K, V> {
  entries: [(K, V)],
}

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/mod
• Line 3: use vitte/stdlib/collections as coll
• Line 4: use vitte/stdlib/io as io
• Line 5: use vitte/stdlib/io/fileops.{ append_file, copy_file, create_directory, delete_directory, delete_file, file_exists, is_directory, is_file, list_directory, move_file, read_file, write_file }
• Line 7: form Vector<T> {
• Line 11: form HashMap<K, V> {
• Line 15: proc vector_new<T>() -> Vector<T> {
• Line 19: proc vector_push<T>(vec: Vector<T>, item: T) -> Vector<T> {

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

Imports

Exports

Integration boundaries

Within stdlib, 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: Top-level map of the Vitte standard library and the responsibilities owned by each family.
• Family architecture role: A realistic Vitte program usually starts in `core`, grows through `collections` or `data`, crosses textual boundaries with `json` or `encoding`, touches the host with `path` or `io`, and only then reaches system-facing families like `kernel`, `ffi`, `async`, or `threading`.

Composition guidance

Choose this module when

• Choose mod.vit when the main question is owned by this module rather than by transport, storage, orchestration, or user-interface code.
• Domain values start in `core` and `strings`.
• Grouped data moves through `collections` or `data`.
• Structured export goes through `json` and `encoding`.
• Filesystem or process interaction goes through `path`, `io`, `os`, or `sysinfo`.
• Explicit runtime coordination goes through `async`, `threading`, `kernel`, or `ffi`.

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 stdlib.
• Check nearby modules such as GETTING_STARTED.vitl, core_alias.vitl, datetime.vitl before adding convenience wrappers here.
• Prefer implementing concrete behavior in leaf modules first; keep the aggregation file focused on composition and export shape.

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

• GETTING_STARTED.vitl
• core_alias.vitl
• datetime.vitl
• graphics.vitl
• memory.vitl
• network/http.vitl
• network/socket.vitl
• network/udp.vitl