Ch26: API Reference
Status
This reference is being written. The tutorial chapters are complete and remain the authoritative explanation of how the library is meant to be used; this section will grow into the lookup layer beside them.
The goal is not a dump of every declaration. It is a map from a task to the type and function that performs it, with the ownership, buffering and error contract stated explicitly.
How the Reference Will Be Organized
| Area | What it covers | Tutorial entry point |
|---|---|---|
| Core I/O | print, scan, transmit, manipulators,
formatting and scanning customization |
Ch11: I/O |
| Devices | native files, buffered files, pipes, sockets, console and memory devices | Ch11: I/O |
| Filesystem and OS layers | POSIX, Win32, NT, Wine, directories, temporary files and mmap | Ch11: I/O |
| Async I/O | tasks, observers, schedulers, accept/connect, async scan/print/transmit | Ch23: Coroutines |
| Containers | string, vector, B-trees, hash containers and views |
Ch4 and Ch9 |
| Compile-time and reflection | type traits, concepts, reflection utilities and generation | Ch24: Reflection |
Until the Reference Is Complete
Use the chapter that introduces the feature. Each page states the header, the type, the operation and the failure contract, and the chapter index is the fastest way to find the right page:
- Ch11: I/O — devices, operations, formatting, files and processes.
- Ch23: Coroutines — the asynchronous model.
- Ch24: Reflection — compile-time reflection.
- Ch20: Freestanding — what changes without an operating system.
If a declaration is missing here, do not guess from the name. Read the introducing chapter first; the reference will link back to it when the entry is written.
Contents
Key Takeaways
- The tutorial chapters explain intent; the API reference will provide lookup.
- Every reference entry must state ownership, buffering and the error contract.
- Start with the chapter that introduces the feature, not with a declaration list.
- This section is under construction; the linked chapters are usable today.