package orsetto

The type constructor 'v model represents the ingestion of 'v values decoded from some interchange language.

Use primitive nym to compose a model that corresponds to all the values of the type associated with nym.

Use cast f m to compose a model that corresponds to the values produced by applying f to the values recognized by scanners for the model m. If applying f raises Not_found, then the scanner recognizes no value. If f raises Failure, then the exception is converted into a Bad_syntax exception from the scanner.

Use defer m to compose a model by forcing m as needed. This is useful for composing recursive data models to be used in the array arguments of the choice and variant model constructors (see below).

Use choice a to compose a model that corresponds to the values produced by the first scanner in the array of scanners corresponding to the models in a.

Use vector m to compose a model that corresponds to a variable length array of values recognized by the scanner for the model m. Use the optional ~a and ~b arguments to constrain the length of the vector to a minimum of a and/or a maximum of b.

Use new index nym to create an index object for the type indicated by nym required for composing table, structure and variant group models. Use the optional ~cmp argument to specify a concrete comparator function to use instead of Stdlib.( = ). Use the optional ~model argument to specify the model explicitly, otherwise the primitive model for nym is used for the domain or index in the compoed group model.

Use table k v to compose a model that corresponds to a variable length array of pairs comprising a domain value of the type described by the index k and a codomain value of the type described by the model v. Use the optional ~a and ~b arguments to constrain the length of the table to a minimum of a and/or a maximum of b.

The abstract type parameter for group elements where the position in the sequence indicates the model for the element.

The type constructor ['g, 'f, 'v] group represents the composition of a group with fields of disparate model in each element on the sequence. The 'g parameter is either element for record groups or 'k index for the other cases. The 'f parameter indicates the type of the composer function that produces the final value from its component parts. The 'v parameter indicates the type of the value produced.

The type constructor ['g, 'p] bind represents the model of a specific element in a group with fields or elements of disparate type. In the case where type 'g is element, the type 'p corresponds to the type indicated by the position in the sequence. In the case where type 'g is 'k index, the type 'p corresponds to the type indicated by its index value.

The empty group that comprises the composition of a value.

Use bind b g to prepend the group element b to the group g.

A submodule containing composers for elements indexed by position.

Use record g f to compose a data model for a record consisting of the elements described by g and the composer f, which is applied to the values scanned in the sequence to produce the result.

A submodule containing composers for elements indexed by some totally ordered domain type.

Use structure i g f to compose a data model for a structure consisting of the fields indexed by i as described by g, with the composer f, which is applied to the values scanned in the sequence to produce the result.

Use variant i s to compose a data model for a variant indexed by i with cases described by s. Raises Invalid_argument if more than one pair k, m in s has the same value of k. The model m describes how the field value is scanned in the case where the index value is k.

A submodule containing affix operators the provide a convenient and idiosyncratic syntax for composing record and structure models.

The extensible control type. Facilitates composing data models with features extended by the ingest specialization for unique features of the interchange language. A value of type ('a, 'b) control represents a conversion of a model of type 'a model to a model of type 'b model as a side effect of any additional constraints applied.

A control value Cast f represents the operation of applying f to a scanned value to produce that value admitted by the model.

Use control m c to compose a new model comprising the application of c to the model m.

Values of type 'k pair are used to describe the structure of pair elements in sequences that comprise group data models indexed by values of type 'k.

Values of type 'k container are used to describe the structure of sequences that comprise group data models.

Values of type occurs describe the optional minimum and maximum number of elements contained by a group data model.

Use occurs () to construct a value of type occurs with validated content. Use ~a to specify a non-negative minimum number of elements. Use ~b to specify a non-negative maximum number of elements. Raises Invalid_argument if either a or b is negative, or if a > b.

Define a module of type Basis to create an ingest specialization.

The module type of ingest specializations.

Use Create(B) to create an ingest specialization from the basis B.