SchemaModule

`Schema`

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

Use Schema.parse for untrusted Data. It decodes fields, applies constraints and refinements, accumulates independent failures as SchemaErrors, and invokes the model constructor only after the fields succeed.

Use Schema.check when a typed value came from another constructor, an import, or a database mapper. It reads the declared fields back from the value and checks them.

The same model constructor runs again, so cross-field invariants are checked too. Success returns the checked value itself.

The Schema quickstart introduces the workflow. The member catalogue below is the complete construction and execution vocabulary.

Summary

Name	Signature	Synopsis
text	Schema.text	Describes text input.
int	Schema.int	Describes a 32-bit integer.
int64	Schema.int64	Describes a 64-bit integer.
decimal	Schema.decimal	Describes a decimal number.
float	Schema.float	Describes a double-precision number.
bool	Schema.bool	Describes a Boolean value.
date	Schema.date	Describes a calendar date.
dateTime	Schema.dateTime	Describes a date and time with an offset.
guid	Schema.guid	Describes a GUID.
listWith	Schema.listWith item	Describes a list using an explicit item schema.
list	Schema.list ()	Describes a list by resolving its item schema from 'item.
option	Schema.option item	Describes an optional value.
mapWith	Schema.mapWith item	Describes a string-keyed map using an explicit value schema.
map	Schema.map ()	Describes a string-keyed map by resolving its value schema from 'item.
defer	Schema.defer schema	Defers a recursive schema reference until an interpreter needs it.
tryConvert	Schema.tryConvert forward backward schema	Maps a schema through a fallible projected conversion.
convert	Schema.convert forward backward schema	Maps a schema through a total, reversible domain conversion.
refine	Schema.refine refinement schema	Maps a raw schema through a reusable bidirectional refinement.
validate	Schema.validate validation schema	Adds executable value validation to a schema.
union	Schema.union cases	Describes the recommended internally tagged union using the type discriminator and named fields.
unionWith	Schema.unionWith representation cases	Describes a union using an explicit complete wire representation.
enum	Schema.enum cases	Describes a scalar enum.
constrain	Schema.constrain constraint' schema	Requires a schema's values to satisfy a constraint.
constrainAll	Schema.constrainAll constraints schema	Requires a schema's values to satisfy every constraint, in declaration order.
mustSupply	Schema.mustSupply schema	Requires boundary input for this schema to be supplied.
mayOmit	Schema.mayOmit schema	Allows boundary input for an option-typed schema to be omitted.
withFormat	Schema.withFormat format schema	Adds format metadata.
describe	Schema.describe text schema	Adds human-readable description metadata.
withDefault	Schema.withDefault value schema	Adds default-value metadata.
format	Schema.format schema	No description available.
description	Schema.description schema	No description available.
defaultValue	Schema.defaultValue schema	No description available.
constraints	Schema.constraints schema	No description available.
supply	Schema.supply schema	Returns the boundary supply declaration attached to a schema, when one was made.
isRefined	Schema.isRefined schema	No description available.
primitiveKind	Schema.primitiveKind schema	No description available.
underlyingPrimitiveKind	Schema.underlyingPrimitiveKind schema	No description available.
rawConstraints	Schema.rawConstraints schema	No description available.
inspectUnderlying	Schema.inspectUnderlying schema	No description available.
allConstraints	Schema.allConstraints schema	No description available.
compilePlan	Schema.compilePlan factory schema	Compiles a record schema with a typed interpreter factory.
defaults	Schema.defaults	The default raw-input parsing options.
constructorErrorAt	Schema.constructorErrorAt path options	Places a record-constructor failure at a field path.
parseWith	Schema.parseWith configure schema input	Parses structured data after configuring parser options.
parse	Schema.parse schema input	Parses source-neutral structured data, runs constraints and refinements, and invokes record constructors.
parseRetainingInput	Schema.parseRetainingInput schema input	Parses source-neutral structured data while retaining it for redisplay and error lookup.
parseWithOptions	Schema.parseWithOptions options schema input	Parses structured data with a C#-friendly options delegate.
check	Schema.check schema value	Checks an existing typed value, such as a freely constructed draft, through the schema's constraints, refinements, and record constructor.
admit	Schema.admit create project draft	Admits a permissive draft model schema into a trusted domain schema through an admission function and a projection, preserving fields, wire names, constraints, and metadata.

text

Schema.text

Member

Describes text input.

Returns

Schema<string>

int

Schema.int

Member

Describes a 32-bit integer.

Returns

Schema<int>

int64

Schema.int64

Member

Describes a 64-bit integer.

Returns

Schema<int64>

decimal

Schema.decimal

Member

Describes a decimal number.

Returns

Schema<decimal>

float

Schema.float

Member

Describes a double-precision number.

Returns

Schema<float>

bool

Schema.bool

Member

Describes a Boolean value.

Returns

Schema<bool>

date

Schema.date

Member

Describes a calendar date.

Returns

Schema<DateOnly>

dateTime

Schema.dateTime

Member

Describes a date and time with an offset.

Returns

Schema<DateTimeOffset>

guid

Schema.guid

Member

Describes a GUID.

Returns

Schema<Guid>

listWith

Schema.listWith item

Member

Describes a list using an explicit item schema.

Parameters

Name	Type	Description
item	Schema<'a>

Returns

Schema<'a list>

list

Schema.list ()

Member

Describes a list by resolving its item schema from 'item.

Parameters

Name	Type	Description
	unit

Returns

Schema<^item list>

option

Schema.option item

Member

Describes an optional value.

Parameters

Name	Type	Description
item	Schema<'a>

Returns

Schema<'a option>

mapWith

Schema.mapWith item

Member

Describes a string-keyed map using an explicit value schema.

Parameters

Name	Type	Description
item	Schema<'a>

Returns

Schema<Map<string, 'a>>

map

Schema.map ()

Member

Describes a string-keyed map by resolving its value schema from 'item.

Parameters

Name	Type	Description
	unit

Returns

Schema<Map<string, ^item>>

defer

Schema.defer schema

Member

Defers a recursive schema reference until an interpreter needs it.

Parameters

Name	Type	Description
schema	unit -> Schema<'a>

Returns

Schema<'a>

tryConvert

Schema.tryConvert forward backward schema

Member

Maps a schema through a fallible projected conversion.

Parameters

Name	Type	Description
forward	'a -> Result<'b, SchemaError list>
backward	'b -> 'a
schema	Schema<'a>

Returns

Schema<'b>

convert

Schema.convert forward backward schema

Member

Maps a schema through a total, reversible domain conversion.

Parameters

Name	Type	Description
forward	'a -> 'b
backward	'b -> 'a
schema	Schema<'a>

Returns

Schema<'b>

refine

Schema.refine refinement schema

Member

Maps a raw schema through a reusable bidirectional refinement.

Parameters

Name	Type	Description
refinement	Refinement<'raw, 'value>
schema	Schema<'raw>

Returns

Schema<'value>

validate

Schema.validate validation schema

Member

Adds executable value validation to a schema.

Parameters

Name	Type	Description
validation	'value -> Result<unit, SchemaError>
schema	Schema<'value>

Returns

Schema<'value>

union

Schema.union cases

Member

Describes the recommended internally tagged union using the type discriminator and named fields.

Parameters

Name	Type	Description
cases	UnionCase<'a> list

Returns

Schema<'a>

unionWith

Schema.unionWith representation cases

Member

Describes a union using an explicit complete wire representation.

Parameters

Name	Type	Description
representation	UnionRepresentation
cases	UnionCase<'a> list

Returns

Schema<'a>

enum

Schema.enum cases

Member

Describes a scalar enum.

Parameters

Name	Type	Description
cases	EnumCase<'a> list

Returns

Schema<'a>

constrain

Schema.constrain constraint' schema

Member

Requires a schema's values to satisfy a constraint.

Parameters

Name	Type	Description
constraint'	Constraint<'a>
schema	Schema<'a>

Returns

Schema<'a>

Verification Examples

Schema.text |> Schema.constrain (Constraint.lengthBetween 2 40)

constrainAll

Schema.constrainAll constraints schema

Member

Requires a schema's values to satisfy every constraint, in declaration order.

Parameters

Name	Type	Description
constraints	Constraint<'a> list
schema	Schema<'a>

Returns

Schema<'a>

Verification Examples

Schema.text |> Schema.constrainAll [ Constraint.present; Constraint.trimmed ]

mustSupply

Schema.mustSupply schema

Member

Requires boundary input for this schema to be supplied.

Parameters

Name	Type	Description
schema	Schema<'a>

Returns

Schema<'a>

Verification Examples

Schema.text |> Schema.mustSupply

mayOmit

Schema.mayOmit schema

Member

Allows boundary input for an option-typed schema to be omitted.

Parameters

Name	Type	Description
schema	Schema<'a option>

Returns

Schema<'a option>

Verification Examples

Schema.option Schema.text |> Schema.mayOmit

withFormat

Schema.withFormat format schema

Member

Adds format metadata.

Parameters

Name	Type	Description
format	SchemaFormat
schema	Schema<'a>

Returns

Schema<'a>

describe

Schema.describe text schema

Member

Adds human-readable description metadata.

Parameters

Name	Type	Description
text	string
schema	Schema<'a>

Returns

Schema<'a>

withDefault

Schema.withDefault value schema

Member

Adds default-value metadata.

Parameters

Name	Type	Description
value	'a
schema	Schema<'a>

Returns

Schema<'a>

format

Schema.format schema

Member

Parameters

Name	Type	Description
schema	Schema<'a>

Returns

SchemaFormat option

description

Schema.description schema

Member

Parameters

Name	Type	Description
schema	Schema<'a>

Returns

string option

defaultValue

Schema.defaultValue schema

Member

Parameters

Name	Type	Description
schema	Schema<'a>

Returns

'a option

constraints

Schema.constraints schema

Member

Parameters

Name	Type	Description
schema	Schema<'a>

Returns

ConstraintDescription list

supply

Schema.supply schema

Member

Returns the boundary supply declaration attached to a schema, when one was made.

Parameters

Name	Type	Description
schema	Schema<'a>

Returns

Supply option

isRefined

Schema.isRefined schema

Member

Parameters

Name	Type	Description
schema	Schema<'a>

Returns

bool

primitiveKind

Schema.primitiveKind schema

Member

Parameters

Name	Type	Description
schema	Schema<'a>

Returns

PrimitiveValueKind

underlyingPrimitiveKind

Schema.underlyingPrimitiveKind schema

Member

Parameters

Name	Type	Description
schema	Schema<'a>

Returns

PrimitiveValueKind

rawConstraints

Schema.rawConstraints schema

Member

Parameters

Name	Type	Description
schema	Schema<'a>

Returns

ConstraintDescription list

inspectUnderlying

Schema.inspectUnderlying schema

Member

Parameters

Name	Type	Description
schema	Schema<'a>

Returns

'a -> 'b

allConstraints

Schema.allConstraints schema

Member

Parameters

Name	Type	Description
schema	Schema<'a>

Returns

ConstraintDescription list

compilePlan

Schema.compilePlan factory schema

Member

Compiles a record schema with a typed interpreter factory.

Parameters

Name	Type	Description
factory	IRecordPlanCompiler<'a, 'b>
schema	Schema<'a>

Returns

defaults

Schema.defaults

Member

The default raw-input parsing options.

Returns

SchemaParseOptions

constructorErrorAt

Schema.constructorErrorAt path options

Member

Places a record-constructor failure at a field path.

Parameters

Name	Type	Description
path	string
options	SchemaParseOptions

Returns

SchemaParseOptions

parseWith

Schema.parseWith configure schema input

Member

Parses structured data after configuring parser options.

Parameters

Name	Type	Description
configure	SchemaParseOptions -> SchemaParseOptions
schema	Schema<'a>
input	Data

Returns

Result<'a, SchemaErrors>

parse

Schema.parse schema input

Member

Parses source-neutral structured data, runs constraints and refinements, and invokes record constructors.

Parameters

Name	Type	Description
schema	Schema<'a>
input	Data

Returns

Result<'a, SchemaErrors>

parseRetainingInput

Schema.parseRetainingInput schema input

Member

Parses source-neutral structured data while retaining it for redisplay and error lookup.

Parameters

Name	Type	Description
schema	Schema<'a>
input	Data

Returns

RetainedParseResult<'a>

parseWithOptions

Schema.parseWithOptions options schema input

Member

Parses structured data with a C#-friendly options delegate.

Parameters

Name	Type	Description
options	Func<SchemaParseOptions, SchemaParseOptions>
schema	Schema<'a>
input	Data

Returns

Result<'a, SchemaErrors>

check

Schema.check schema value

Member

Checks an existing typed value, such as a freely constructed draft, through the schema's constraints, refinements, and record constructor.

Parameters

Name	Type	Description
schema	Schema<'a>
value	'a

Returns

Result<'a, SchemaErrors>

admit

Schema.admit create project draft

Member

Admits a permissive draft model schema into a trusted domain schema through an admission function and a projection, preserving fields, wire names, constraints, and metadata.

Parameters

Name	Type	Description
create	'draft -> Result<'domain, SchemaError list>
project	'domain -> 'draft
draft	Schema<'draft>

Returns

Schema<'domain>