API Reference

The Schema module contains primitive schemas, collection and recursion combinators, union constructors, and the operations that parse or check a completed declaration.

The concise schema-definition vocabulary: the record computation expression, its field and constructor forms, and the collection-schema operations.

Functions for inspecting schema field metadata.

Declares one field inside schema<'model> { }, and configures it when followed by a block.

Functions for defining explicit payload-less enum schema cases.

Functions for defining explicit tagged union schema cases.

Represents the source-facing name of a schema field.

Represents the zero-based position of a schema field in a model constructor and ordered interpreter output.

Ready-made schemas for the built-in refined values.

Canonical value-schema resolution for a schema field.

Identifies the portable named format of a schema value, such as email.

Whether boundary input for a field must be supplied.

UnionRepresentation is a complete, inspectable union wire representation.

UnionRepresentations holds complete, ready-made union wire representations for recommended authoring and serializer-compatible lifting.

UnionPayloadStyle controls how a case's authored fields are represented inside adjacent or external union tagging.

Builds an interpreter-specific typed record plan from a model schema's authored shape.

Holds an interpreter-specific typed record-plan fragment while compiling a schema.

Schema input, checking, and contextual rule failures attached to diagnostics paths.

One or more accumulated schema failures.

One schema failure and its complete structural location.

An immutable location within structured schema input.

Options that customize how structured data is parsed through a schema.

Functions for creating and rendering retained schema parse results.

Functions for running executable value checks against refined and primitive value schemas.

SchemaMessages is Reified.Schema's own message catalogue for parse, boundary-supply, and structural failures.

Marks the package that owns schema input, diagnostics, validation, and rules interpreters.

Inspect.model turns a completed model schema into finite metadata: field names, nested shapes, union cases, and the inspectable constraints attached to each value.

Json.compile interprets a Schema<'model> as a reusable JsonCodec<'model>.

A compiled JSON codec for one schema-described model.

The exception raised when JSON text cannot be decoded through a compiled schema codec.

Indentation applied to nested levels by the JSON writer.

Line ending used for the indentation newlines and the optional trailing newline.

Cosmetic options for the JSON writer.

JsonSchema.generate publishes a schema as JSON Schema Draft 2020-12.

A schema describes the current model.

A progressively typed version chain.

A failure to select, parse, or migrate a versioned contract.

A failure produced while migrating an older wire representation.

VersionSource is the explicit source of a contract version, chosen with Contract.build when a versioned contract is declared.

Describes a built model schema as an ordered list of field descriptions.

Describes one field of a model schema for inspection interpreters.

Describes one value schema: its shape, declared format, and portable constraint metadata.

Describes the shape of a value schema as inspectable metadata for non-validation interpreters.

Identifies the intrinsic primitive shape of a schema value.

Describes one case in a bare-string enum value schema.

Describes a bare-string enum value schema.

Describes one case in a union value schema.

Describes the semantic payload shape of one union case.

Describes a tagged union value schema.

Bounds a numeric field's value inclusively from below (>= in the contract grammar).

Bounds a numeric field's value inclusively from above (<= in the contract grammar).

Supplies the field's default when the payload omits it.

Marks a plain record for schema derivation: schemagen generates its permissive schema.

Marks a discriminated union for generated Schema support.

Requires the elements of a list field to be distinct.

Constrains a text field to the email format.

Adds open format metadata to the field schema.

Bounds a numeric field's value exclusively from below (> in the contract grammar).

Requires the natural length of a text, list, or map field to equal the supplied value.

Bounds the natural length of a text, list, or map field inclusively.

Bounds a numeric field's value exclusively from above (< in the contract grammar).

Bounds the natural length of a text, list, or map field from above.

Bounds the natural length of a text, list, or map field from below.

Constrains a numeric field's value to whole multiples of the given step.

Constrains a text field to the given regular expression.

Requires a string, collection, or optional field value to be present.

Adds one exact, input-only alternate wire name for a generated record field.

Marks the static member the derived schema calls to assemble the record, instead of a record literal.

Overrides the external name of one record field or one nullary union case.

Requires the input payload to supply the field key.

Selects how generated case fields are nested by adjacent or external representations.

Selects a complete generated union wire representation.