API Reference skuld v#0.33.1

Copy Markdown View Source

Modules

Core computation engine and foundational effects for the Skuld ecosystem.

Sentinel indicating a computation was cancelled.

Environment construction and manipulation.

External suspension for yielding to code outside Skuld's env threading.

Suspension for external/foreign resources (e.g., JavaScript Promises).

Behaviour for effect operation handlers.

Behaviour for effects supporting handler installation via catch clauses.

Behaviour for effects supporting local interception via catch clauses.

Protocol for handling sentinel values in run/run! and generic sentinel inspection.

Protocol for unwrapping exceptions in Throw.try_catch/1.

Behaviour for effect operation handlers that are provably total and linear.

Raised when a non-computation value is used where a computation is expected.

Represents a pattern match failure in a comp block.

Scope machinery carried through a computation.

Error result that Catch recognizes

Exception raised when a Skuld computation throws via Throw.throw/1 and the error is not caught.

Type definitions for Skuld.Comp.

Exception raised when an Elixir exit is not caught within a Skuld computation.

Exception raised when an Elixir throw is not caught within a Skuld computation.

Bracket effect for safe resource acquisition and cleanup.

Effect for dispatching commands through a unified pipeline.

Fresh effect - generate fresh/unique UUIDs.

FreshInt effect — generate monotonically increasing integers.

FxFasterList - High-performance effectful list operations.

FxList - Effectful list operations with full control effect support.

Random effect - generate random values.

Reader effect - access an immutable environment value.

State effect - mutable state threaded through computation.

Represents a state change with old and new values.

Throw/Catch effects - error handling with scoped catching.

Transaction effect — env state rollback with optional database transactions.

Writer effect - accumulate a log during computation.

Yield effect - coroutine-style suspension and resumption.

Syntax module providing the computation do-notation macro.

Mix Tasks

Injects navigation headers and footers into documentation files.