On this page:
Xiden:   API Reference
7.9

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 Model

    2 Package Definitions

      2.1 Package Definition Terms

      2.2 Additional Bindings

      2.3 Static Operations for Package Definitions

        2.3.1 Package Definition Construction and Destructuring

        2.3.2 Package Definition Analysis

        2.3.3 Package Definition Code Generation

        2.3.4 Package Definition Transformations

    3 Packages

      3.1 Package Messages

    4 Reader Extension

    5 Package Definition Versions

      5.1 Editions

      5.2 Revisions

      5.3 Package Version API

    6 Package Queries

      6.1 Package Query Syntax

      6.2 Package Query Omissions

      6.3 Package Query Classifications

      6.4 Parsing a Package Query

      6.5 Package Query API

    7 Workspaces

      7.1 Selecting a Workspace

      7.2 State Management

        7.2.1 Garbage Collection

    8 Configuration

      8.1 Settings

      8.2 Runtime Configuration

        8.2.1 Changing a Runtime Configuration Value

        8.2.2 Runtime Configuration Files

        8.2.3 Runtime Configuration API

        8.2.4 Setting Reference

    9 Messages

    10 Logged Procedures

      10.1 Fundamentals

      10.2 Terminal Values

      10.3 Alternative Constructors

      10.4 Logged Program Control

      10.5 Entry Points for Logged Programs

      10.6 Testing Logged Procedures

    11 Codec

      11.1 High-Level Interface

      11.2 UTF-8 Conversions

      11.3 Abbreviated Decoding Procedures

    12 Command Line Interface

      12.1 Command Line Flags

      12.2 Command Line Utilities

        12.2.1 CLI Value Types

        12.2.2 CLI Flow Control

        12.2.3 CLI Messages

      12.3 Command Line Argument Parsers

    13 Data Verification

      13.1 Integrity Checking

      13.2 Signature Checking

        13.2.1 Signature Verification Model

        13.2.2 Signature Check Bindings

    14 Racket Module Operations

      14.1 Stripping and Dressing

    15 Data Sourcing

      15.1 Source Types

      15.2 Source Expressions

      15.3 Transferring Bytes

    16 Resolving Inputs

    17 Plugins

      17.1 Supported Bindings

    18 Formatting

      18.1 Conventional Formatting Procedures

      18.2 Message Formatting

    19 Exceptions

    20 URLs

    21 String Processing

    22 Localization

    23 Printer

    24 Archives

    25 System

    26 Monads

    27 File System

    28 Security

    29 Maintainance Information

      29.1 Basic Information

        29.1.1 User Experience Notice

        29.1.2 Security Notice

      29.2 Affirmations