reef-stdlib API Documentation
Generated: 2026-08-26
Modules
collections
| Module | Description |
|---|---|
| collections.bitset | collections/bitset - Efficient Bit Set Data Structure |
| collections.growable | collections/growable - Growable arrays for common types |
| collections.hashmap | collections/hashmap - Generic Hash Map implementation |
| collections.hashset | collections/hashset - Generic Hash Set implementation |
| collections.list | collections/list - Generic List[T] collection |
| collections.map | collections/map - Hash map implementations |
| collections.ordered_map | collections/ordered_map - Insertion-Order Preserving Map |
| collections.queue | collections/queue - Generic Queue[T] collection (FIFO) |
| collections.set | collections/set - Generic Set implementation |
| collections.stack | collections/stack - Generic Stack[T] collection (LIFO) |
| collections.trie | collections/trie - Prefix Tree (Trie) Data Structure |
| collections.vec | collections/vec - Generic Growable Vector |
compiler
| Module | Description |
|---|---|
| compiler.diagnostics | compiler/diagnostics - Diagnostic Collection and Formatting |
| compiler.source | compiler/source - Source Location Tracking for Compilers |
| compiler.symbol_table | compiler/symbol_table - Scoped Symbol Table for Compilers |
compress
| Module | Description |
|---|---|
| compress.gzip | compress/gzip - Gzip compression using zlib FFI |
| compress.lz4 | compress/lz4 - LZ4 fast compression using FFI |
| compress.zip | compress/zip - ZIP archive handling using libzip FFI |
| compress.zlib | compress/zlib - Zlib compression using FFI |
core
| Module | Description |
|---|---|
| core.array | core.array - Array utility functions |
| core.box | core.box - Box types for wrapping primitive values |
| core.chars | core.chars - Character classification and conversion functions |
| core.convert | core.convert - Type conversion functions |
| core.error | core.error - Shared structured Error type |
| core.memory | core.memory - Pure Reef memory operations |
| core.option | core.option - Generic optional value type for safe null handling |
| core.result | core.result - Result types for error handling |
| core.str | core.str - String manipulation functions |
crypto
| Module | Description |
|---|---|
| crypto.bitops | crypto/bitops - Bit operations for cryptographic algorithms |
| crypto.crc32 | crypto/crc32 - CRC32 checksum calculation |
| crypto.hmac | crypto/hmac - HMAC (Hash-based Message Authentication Code) |
| crypto.md5 | crypto/md5 - MD5 message-digest algorithm |
| crypto.sha1 | crypto/sha1 - SHA-1 message-digest algorithm |
| crypto.sha256 | crypto/sha256 - SHA-256 message-digest algorithm |
encoding
| Module | Description |
|---|---|
| encoding.base64 | encoding/base64 - Base64 encoding and decoding (RFC 4648) |
| encoding.csv | encoding/csv - CSV (Comma-Separated Values) parsing and generation |
| encoding.hex | encoding/hex - Hexadecimal encoding and decoding |
| encoding.html | encoding/html - HTML entity encoding and decoding |
| encoding.ini | encoding/ini - INI file parsing |
| encoding.json | encoding/json - JSON parsing and generation |
| encoding.msgpack | encoding/msgpack - MessagePack binary serialization |
| encoding.toml | encoding/toml - TOML configuration file parsing |
| encoding.url | encoding/url - URL percent encoding and decoding |
| encoding.utf8 | encoding/utf8 - UTF-8 encoding and codepoint utilities |
| encoding.varint | encoding/varint - Variable-length integer encoding |
| encoding.yaml | encoding/yaml - Simple YAML parsing |
fs
| Module | Description |
|---|---|
| fs.link | fs/link - Symlink and hard link operations |
| fs.ops | fs/ops - File copy, remove, and rename operations |
| fs.perm | fs/perm - File permission operations |
| fs.stat | fs/stat - File metadata and type queries |
gameui
| Module | Description |
|---|---|
| gameui.context | gameui/context.reef - Immediate mode UI context |
| gameui.input | gameui/input.reef - Input state for immediate mode UI |
| gameui.style | gameui/style.reef - Styling for immediate mode UI |
| gameui.widgets | gameui/widgets.reef - Immediate mode UI widgets |
graphics
| Module | Description |
|---|---|
| graphics.backend.memory | graphics/backend/memory.reef - In-memory rendering surface |
| graphics.backend.software | graphics/backend/software.reef - Pure Reef software rasterizer |
| graphics.backend.surface | graphics/backend/surface.reef - Rendering surface (passive-object hierarchy) |
| graphics.canvas | graphics/canvas.reef - Stateful drawing context |
| graphics.core | graphics/core.reef - Core types for 2D graphics |
| graphics.font.bitmap | graphics/font/bitmap.reef - Bitmap font implementation |
| graphics.font.font | graphics/font/font.reef - Font types and traits |
| graphics.font.text | graphics/font/text.reef - Text layout |
| graphics.font.ttf | graphics/font/ttf.reef - TrueType font parser |
| graphics.image | graphics/image.reef - Image types and pixel operations |
| graphics.image.bmp | graphics/image/bmp.reef - BMP file format loader and writer |
| graphics.image.png | graphics/image/png.reef - PNG file format loader |
| graphics.paint | graphics/paint.reef - Paint styles for fills and strokes |
| graphics.path | graphics/path.reef - Vector path construction |
| graphics.transform | graphics/transform.reef - 2D affine transformations |
io
| Module | Description |
|---|---|
| io.buffer | io/buffer - Buffered I/O (BufferedReader / BufferedWriter objects) |
| io.console | io/console - Console input/output operations |
| io.dir | io/dir - Directory operations |
| io.file | io/file - File input/output operations |
| io.path | io/path - Path manipulation utilities |
| io.stream | io/stream - Stream hierarchy (passive objects) for I/O |
libc
| Module | Description |
|---|---|
| libc.cstring | libc.cstring - C standard library string functions (FFI) |
| libc.ctype | libc.ctype - C character type functions (FFI) |
| libc.format | libc.format - Number formatting and parsing (compatibility façade) |
| libc.memory | libc.memory - C standard library memory functions (FFI) |
math
| Module | Description |
|---|---|
| math.basic | math/basic module |
| math.floats | math/floats - Extended floating-point mathematical functions |
| math.random | math/random - Random number generation |
net
| Module | Description |
|---|---|
| net.address | net.address - IP address parsing and utilities |
| net.dns | net.dns - DNS hostname resolution |
| net.extras | net.extras - Extra utilities for HTTP downloads |
| net.http | net.http - HTTP/1.1 client with HTTPS support |
| net.socket | net.socket - Low-level socket constants and utilities |
| net.tcp | net.tcp - TCP socket operations |
| net.tls | net.tls - TLS/SSL secure connections using the system OpenSSL |
| net.udp | net.udp - UDP datagram socket operations |
| net.unix | net/unix - Unix domain sockets |
reefvision
| Module | Description |
|---|---|
| reefvision.cell | reefvision.cell — geometry, styles, cell buffer, dirty flush |
| reefvision.commands | reefvision.commands - command enable/disable + accelerator table (Wave 3) |
| reefvision.desktop | reefvision.desktop — Desktop + Application event loop (design §10.1–10.2) |
| reefvision.event | reefvision.event — KeyCode, KeyEvent, MouseEvent, Event, toolkit command IDs |
| reefvision.input | reefvision.input — pure byte stream → KeyEvent / Event decoder |
| reefvision.term | reefvision.term — terminal host surface for ReefVision |
| reefvision.theme | reefvision.theme — semantic palette, box glyphs, TOML load, RGB quantizers |
| reefvision.view | reefvision.view — View/Group object engine: bounds, clip, draw walk, focus |
| reefvision.widgets.button | reefvision.widgets.button — focusable command button (design §10.5) |
| reefvision.widgets.checkbox | reefvision.widgets.checkbox — toggle with "[X] label" / "[ ] label" |
| reefvision.widgets.inputline | reefvision.widgets.inputline — single-line text field (design §10.5) |
| reefvision.widgets.label | reefvision.widgets.label — static text leaf (design §10.5) |
| reefvision.widgets.listbox | reefvision.widgets.listbox — selectable list with optional scrollbar |
| reefvision.widgets.menubar | reefvision.widgets.menubar — top menu bar, pull-downs, one-level submenus, |
| reefvision.widgets.messagebox | reefvision.widgets.messagebox — modal dialog (design §10.4–10.5) |
| reefvision.widgets.progress | reefvision.widgets.progress — determinate + indeterminate gauge (Wave 4) |
| reefvision.widgets.radio | reefvision.widgets.radio — exclusive radio group "(*) label" / "( ) label" |
| reefvision.widgets.scrollbar | reefvision.widgets.scrollbar — thumb math + frame-integrated scroll gutter |
| reefvision.widgets.table | reefvision.widgets.table — columns, header row, row selection (Wave 5) |
| reefvision.widgets.textarea | reefvision.widgets.textarea — multi-line editor (Wave 5) |
| reefvision.widgets.window | reefvision.widgets.window — framed Group (design §5 / object-rewrite §5) |
sync
| Module | Description |
|---|---|
| sync.mutex | sync/mutex - Mutual exclusion primitives |
sys
| Module | Description |
|---|---|
| sys.debug | sys/debug - Runtime debugging and diagnostics |
| sys.env | sys/env - Environment variable operations |
| sys.fd | sys/fd - File descriptor operations |
| sys.optparse | sys.optparse - hierarchical CLI option parser (clap-style) |
| sys.platform | sys/platform - System and platform information |
| sys.platform.constants.darwin_arm64 | sys/platform/constants/darwin_arm64 - macOS ARM64 (Apple Silicon) Constants |
| sys.platform.constants.freebsd | sys/platform/constants/freebsd - FreeBSD-Specific Constants |
| sys.platform.constants.linux | sys/platform/constants/linux - Linux-Specific Constants |
| sys.platform.constants.openbsd | sys/platform/constants/openbsd - OpenBSD-Specific Constants |
| sys.platform.constants.posix | sys/platform/constants/posix - Common POSIX Constants |
| sys.platform.libc | sys/platform/libc - Consolidated C Library FFI Declarations |
| sys.platform.raw.linux_amd64 | sys.platform.raw.linux_amd64 - Linux AMD64 raw syscall interface |
| sys.platform.raw.linux_arm64 | sys.platform.raw.linux_arm64 - Linux ARM64 raw syscall interface |
| sys.platform.runtime | sys/platform/runtime - Reef Runtime FFI Declarations |
| sys.poll | sys/poll - poll(2) event loop |
| sys.process | sys/process - Process spawning and management |
| sys.signal | sys/signal - Signal handling |
test
| Module | Description |
|---|---|
| test.framework | test/framework - Minimal test framework for Reef |
text
| Module | Description |
|---|---|
| text.string_interner | text/string_interner - String Interning for Memory Efficiency |
| text.stringbuilder | text.stringbuilder - Efficient string building |
time
| Module | Description |
|---|---|
| time.clock | time/clock - Time and sleep functions |
| time.date | time/date - Date handling functions |
| time.time | time/time - Time and date functions |
ui
| Module | Description |
|---|---|
| ui.app | ui/app.reef - Application lifecycle management |
| ui.backend.framebuffer | ui/backend/framebuffer.reef - Linux framebuffer backend |
| ui.backend.macos | ui/backend/macos.reef - macOS native window backend using Cocoa |
| ui.backend.platform | ui/backend/platform.reef - Platform abstraction for windowing systems |
| ui.backend.tty | ui/backend/tty.reef - Terminal/TTY backend using ANSI escape codes |
| ui.backend.x11 | ui/backend/x11.reef - X11 window system backend |
| ui.event | ui/event.reef - Event types for UI system |
| ui.focus | ui/focus.reef - Focus management for UI |
| ui.layout.box | ui/layout/box.reef - Simple box/stack layout |
| ui.layout.flex | ui/layout/flex.reef - CSS Flexbox-inspired layout |
| ui.layout.layout | ui/layout/layout.reef - Core layout types and constraints |
| ui.theme | ui/theme.reef - Theme system for UI styling |
| ui.widget | ui/widget.reef - Widget types and base functionality |
| ui.widgets.button | ui/widgets/button.reef - Clickable button widget |
| ui.widgets.checkbox | ui/widgets/checkbox.reef - Boolean toggle control |
| ui.widgets.label | ui/widgets/label.reef - Text display widget |
| ui.widgets.panel | ui/widgets/panel.reef - Container widget with background |
| ui.widgets.progress | ui/widgets/progress.reef - Progress bar display |
| ui.widgets.scrollview | ui/widgets/scrollview.reef - Scrollable container widget |
| ui.widgets.slider | ui/widgets/slider.reef - Value slider control |
| ui.widgets.textfield | ui/widgets/textfield.reef - Single-line text input |
| ui.window | ui/window.reef - Window management for UI |
Generated by reefc doc