On this page:
Xiden:   API Reference
8.0

Xiden: API Reference

Sage L. Gerard <sage at sagegerard dot com>

This is the API reference for Xiden.

For a high-level overview, see Xiden: A Guide for Functional Dependency Management in Racket.

Warning: The API is currently unstable.

    1 Command Line Interface

      1.1 Command Line Flags

      1.2 Command Line Utilities

        1.2.1 CLI Value Types

        1.2.2 CLI Flow Control

        1.2.3 CLI Messages

      1.3 Command Line Argument Parsers

    2 Model

      2.1 Package Definitions

        2.1.1 Package Definition Terms

        2.1.2 Reprovided Binding Index

        2.1.3 Static Operations for Package Definitions

          2.1.3.1 Package Definition Construction and Destructuring

          2.1.3.2 Package Definition Analysis

          2.1.3.3 Package Definition Code Generation

          2.1.3.4 Package Definition Transformations

      2.2 Packages

        2.2.1 Package Messages

      2.3 Reader Extension

      2.4 Package Definition Versions

        2.4.1 Editions

        2.4.2 Revisions

        2.4.3 Package Version API

      2.5 Package Queries

        2.5.1 Package Query Syntax

        2.5.2 Package Query Omissions

        2.5.3 Package Query Classifications

        2.5.4 Parsing a Package Query

        2.5.5 Package Query API

      2.6 Workspaces

        2.6.1 Selecting a Workspace

        2.6.2 State Management

          2.6.2.1 Garbage Collection

      2.7 Data Sourcing

        2.7.1 Defining Source Types

        2.7.2 Source Types

        2.7.3 Source Expressions

        2.7.4 Untrusted Source Expressions

        2.7.5 Transferring Bytes

      2.8 Catalogs

        2.8.1 Built-in Catalog Variants

      2.9 Resolving Inputs

      2.10 Plugins

        2.10.1 Supported Bindings

      2.11 Configuration

        2.11.1 Settings

        2.11.2 Runtime Configuration

          2.11.2.1 Changing a Runtime Configuration Value

          2.11.2.2 Runtime Configuration API

          2.11.2.3 Setting Reference

      2.12 Data Verification

        2.12.1 Integrity Checking

        2.12.2 Signature Checking

          2.12.2.1 Signature Verification Model

          2.12.2.2 Signature Check Bindings

    3 Supporting Modules

      3.1 Formatting

        3.1.1 Conventional Formatting Procedures

        3.1.2 Message Formatting

      3.2 Exceptions

      3.3 URLs

      3.4 String Processing

      3.5 Localization

      3.6 Printer

      3.7 Archives

      3.8 System

      3.9 Monads

      3.10 File System

      3.11 OpenSSL

      3.12 Restricted Runtime Configuration Access

      3.13 Security

      3.14 Racket Module Operations

        3.14.1 Stripping and Dressing

        3.14.2 Fetching Racket Modules in Package Definition

      3.15 Messages

      3.16 Logged Procedures

        3.16.1 Fundamentals

        3.16.2 Terminal Values

        3.16.3 Alternative Constructors

        3.16.4 Logged Program Control

        3.16.5 Entry Points for Logged Programs

        3.16.6 Testing Logged Procedures

      3.17 Codec

        3.17.1 High-Level Interface

        3.17.2 UTF-8 Conversions

        3.17.3 Abbreviated Decoding Procedures

    4 Maintainance Information

      4.1 Basic Information

        4.1.1 User Experience Notice

        4.1.2 Security Notice

      4.2 Affirmations