The Catalyst
API reference.

A convenience include for everyday Catalyst programs, with short scalar and vector type names.

Fundamental concepts, numeric limits, hashes, index ranges, and output helpers.

A dynamic value for scalars, collections, symbols, expressions, and native objects.

A byte string with familiar string operations and concise text, conversion, and hashing helpers.

Framework errors, assertions, stack traces, and exception translation.

Application options, configuration, signals, and process-wide lifecycle helpers.

Register resources for coordinated application shutdown.

A fixed-size array with tuple access, standard array operations, and Catalyst conveniences.

A non-owning view of contiguous elements, with dynamic or fixed extent.

A growable contiguous sequence with standard vector operations and concise additions.

A double-ended sequence with efficient insertion and removal at either end.

A linked sequence with stable element positions and splice operations.

A bounded vector that stores a variable number of elements within a fixed capacity.

A fixed-size arithmetic vector with component-wise operations and numeric vector aliases.

A sorted unique sequence with vector-style indexing and set operations.

An ordered key–value container with unique keys and convenient lookup and merging.

An ordered key–value container that permits repeated keys.

A hash-based key–value container with unique keys.

An ordered map backed by contiguous key and value sequences.

An ordered collection of unique keys.

A hash-based collection of unique keys.

An ordered set with contiguous storage and set-algebra conveniences.

Owned or borrowed byte buffers with a read cursor, serialization, compression, and file I/O.

Base64, Base62, URL encoding, Unicode conversion, and compact data tags.

Compress and decompress complete byte strings using gzip.

Read CSV headers and rows, or convert a complete CSV document into values.

Parse CSON text or files into Catalyst values and expression trees.

Write values and symbolic expressions as CSON or JSON.

Compile a regular expression, match whole strings, or collect all occurrences.

Simple functions for paths, files, environment variables, processes, and system information.

Calendar conversion, Unix timestamps, nanosecond timestamps, and the cosmic time scale.

Pseudorandom samples, distribution helpers, shuffling, and selection.

Mutexes, scoped locks, semaphores, asynchronous calls, and thread groups.

A queue-driven thread pool and the FIFO `CPool` convenience alias.

Concurrent FIFO, blocking, priority, and timed work queues.

Start a process, stream its input and output, wait for completion, and control its lifetime.

Local persistent databases and typed, indexed row tables.

Execute SQL over local Catalyst tables and deliver result rows to a delegate.

A concise PostgreSQL interface for schemas, parameterized queries, and transactions.

Persist entries, named attributes, directed relationships, and indexed numeric queries.

Store JPEG-compressed movie frames and metadata, then export encoded video.

Exchange native Catalyst messages, observe callbacks, and make synchronous calls.

Accept native messenger connections and delegate application admission.

Make HTTP requests with text, JSON-value, or binary responses.

Serve files from a document root with configurable request handling.

A TLS WebSocket client for Catalyst values, with queued or delegated receiving.

Parse Cosmic source and expressions into Catalyst syntax trees.

Parse Microcosm source and expressions into Catalyst syntax trees.

An extensible interpreter for Microcosm expression and statement nodes.

Encode, decode, and place JPEG images in four-channel pixel buffers.

Draw paths, shapes, text, and images into an RGBA bitmap.

Render models, procedural geometry, lighting, and animation into a bitmap.

Build a plot from a declarative value configuration and named numeric data.

Load and dispatch a compiled Metal kernel using ordinary Catalyst buffers and values.

The C ABI for values, errors, runtimes, messengers, and servers.

Convert between native C++ values and explicitly selected C binding adapters.

The forwarding interface of the proxy returned by string-key indexing on a value.

Row descriptors, field selections, row concepts, and supporting typed-table declarations.

A schema-driven row table whose records and query descriptions are dynamic values.

An included support header used by local-database index templates.