Stdlib module profiling/profiler.vitl

Overview

`profiling/profiler.vitl` is a public stdlib surface 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.

• Use this module when bytes or paths cross a host boundary and architecture must keep that boundary visible.
• 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`.

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.

• Compact procedure surface: this file is small enough to read end-to-end before depending on it.
• 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.
• 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 11 of 15 in the stdlib family when ordered by path. By procedure count it ranks 13, and by line count it ranks 11. 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 7 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 ProfilerSample { (line 5)
• form ProfilerReport { (line 11)
• proc profile_report(target: string, samples: u64, total_ns: u64, allocations: u64, hottest: string) -> ProfilerReport { (line 20)
• proc profiler_summary(report: ProfilerReport) -> string { (line 31)
• proc profiler_empty() -> ProfilerReport { (line 38)
• proc profiler_selftest() -> bool { (line 42)

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 profiling/profiler.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/profiling_profiler
form DemoState {
  ready: bool,
  note: string
}
proc run_example() -> DemoState {
  let ready: bool = profiler_selftest()
  if not ready {
    give DemoState { ready: false, note: "not-ready" }
  } else {
    give DemoState { ready: true, 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.

Keywords still not exercised directly in the generated snippet: and, or, as. The page still lists them here so the gap is visible.

Source shape

space vitte/stdlib/profiling/profiler
export *
form ProfilerSample {
  name: string
  duration_ns: u64
  allocations: u64
}
form ProfilerReport {
  target: string
  samples: u64

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/profiling/profiler
• Line 3: export *
• Line 5: form ProfilerSample {
• Line 11: form ProfilerReport {
• Line 20: proc profile_report(target: string, samples: u64, total_ns: u64, allocations: u64, hottest: string) -> ProfilerReport {
• Line 31: proc profiler_summary(report: ProfilerReport) -> string {
• Line 38: proc profiler_empty() -> ProfilerReport {
• Line 42: proc profiler_selftest() -> 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.

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

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 profiling/profiler.vitl when 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.
• 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`.

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.

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
• mod.vit
• network/http.vitl
• network/socket.vitl