package orsetto

You can search for identifiers within the package.

in-package search v0.2.0

A library of assorted structured data interchange languages

Install

Dune Dependency

bitbucket.org Edit opam file Versions (8)

Authors

J

james woodyatt <jhw@conjury.org>

Maintainers

J

james woodyatt <jhw@conjury.org>

Sources

r1.0.3.tar.gz

sha256=151ca6df499bd3de7aa89a4e1627411fbee24c4dea6e0e71ce21f06f181ee654

md5=00393728b481c2bf15919a8202732335

doc/orsetto.cf/Cf_radix_n/index.html

Module `Cf_radix_n`

Support logic for arbitrary Radix-N transcodings.

Overview

This module provides the basis interface for Radix-16, -32 and -64 encodings using arbitrary alphabets.

Note well: the implementation comprises a record type and a function that returns a first-class module, rather than a functor, for internal reasons related to Radix-32 transformations requiring a working accumulator that is either int or int64 depending on the value of Sys.int_size.

Basis Types

type check =

| Digit
| Skip
| Pad
| Invalid

Values of this type are returned by check functions.

type req =

| Must
| Should

Values of this type signal whether pad characters are required or merely recommended.

type basis =

| Basis of {
1. pad : (req * char) option;
  (*
  Pad characters.
  *)
2. check : char -> check;
  (*
  Check the kind of character.
  *)
3. decode : char -> int;
  (*
  Return the digit for a character.
  *)
4. encode : int -> char;
  (*
  Return the character for a digit.
  *)
5. radix : int;
  (*
  The radix of the transform.
  *)
}

Values of this type describe the form of the Radix-N transform.

Composition

type exn += private

| Error

The exception signaling a encoding error.

module type Profile = sig ... end

Modules of this type implement the various transcoding methods.

val create : basis -> (module Profile)

Use create b to make a module that implements the encoding.

On This Page

Overview
Basis Types
Composition