ReifiedReified
  • Docs
  • Reference
  • Packages
  • GitHub
  • 0.11.2
    • 0.11.2
    • 0.11.1
    • 0.11.0
    • 0.10.0
    • 0.9.0
    • 0.8.2
    • 0.8.1
    • 0.8.0
    • 0.7.0
    • 0.6.1
    • 0.6.0
    • 0.5.0
    • 0.4.0
    • 0.3.0
    • 0.2.0
  • light
  • dark

Reified.SchemaGen

Package

Contents

EmitterModuleFieldDeclModuleGenerationPipelineModuleGeneratedFileRecordParserModuleRecordsModuleResolverModuleAnnotationRecordConstraintDeclUnionContractDeclRecordContractDiagnosticRecordContractFileRecordContractRefRecordExternalEnumCaseRecordExternalUnionCaseRecordExternalUnionFieldRecordExternalUnionPayloadUnionExternalUnionRepresentationUnionFieldDeclRecordFieldTypeUnionLiteralUnionPrimitiveTypeUnionSchemaNamingUnionUnionCaseDeclRecord

On This Page

    Overview

    • Home
    • API Reference

    Docs

    • Getting Started
      • Getting Started
      • What a schema gives you
      • Where to go next
    • Schema
      • Schema
      • Quickstart
      • Schema Tutorials
        • Schema Tutorials
        • Signup Form Tutorial
        • Nested Models And Collections Tutorial
        • Inspecting Schema Metadata Tutorial
      • Refined fields in Schema
      • Constraints and localization in schemas
      • Boundary-specific field rules
      • SchemaDSL
      • Input Sources
      • Field Blocks and Plain Functions
      • Redisplay And Field Errors
      • Construction Guarantees
      • Refined Schemas
      • Union Schemas
      • Advanced Union Handling
      • Schema or Generated DTO
      • JSON Codecs
      • HTTP JSON boundary recipe
      • Derived Schemas
        • Derived Schemas
        • Build Generation
        • Derivation Attributes
        • Schema Inference
        • Generated Code
      • Handwritten Versioned Contracts
      • Generated version series
      • Recommended Patterns
        • Recommended Patterns
        • Build A Private Aggregate
        • Model Legal Transitions
        • Separate Wire And Domain Models
        • Split A Larger Application
      • Runnable Examples
      • Walkthrough: Reference Apps
    • Constraints
      • Constraints
      • Quickstart
      • ConstraintDSL
      • Using constraints
      • Constraint
      • Interpreted and opaque
      • Working with violations
      • Fable support
      • Constraint tutorials
        • Constraint tutorials
        • Constraint and Result Tutorial
      • Introductory Reference App
    • Localization
      • Localization
      • Context and fallback
      • Custom rules
      • Advanced rendering
      • The key catalogue
      • Adding a language
    • Refined
      • Refined
      • Built-in Refined Values
      • Compose Parse and Refinement
      • Define Refined Types
      • Schema Integration
      • Tutorials
        • Tutorials
        • Order Totals Tutorial
        • Customer Id Tutorial
    • Parsing
      • Parsing
    • Data
      • Data
      • Build, vary, and test structured data
      • Using Data with Reified
      • What Data represents
      • DataDSL
      • Declare, render, and edit data
      • Match selected parts of data
      • Numbers
      • Convert data and parse JSON
      • Build variations and matrices
      • Test Schema Guarantees
      • Compare complete data
    • Result handling
      • Result handling
      • Quickstart
      • Creating a Result
      • Transforming values
      • Handling errors
      • Extracting values
      • Working with collections
      • Observing a Result
      • The result computation expression
      • Collecting every error
    • Guides
      • Guides
      • Task index
      • Choosing an API
      • Error taxonomy and recipes
      • Glossary
    • Comparisons
      • Comparisons
      • How it compares
      • vs FluentValidation
      • vs zod
      • FsToolkit.ErrorHandling
    • Notes
      • Notes
      • Benchmarks
      • Compiler-Directed, AOT, and Fable
      • Package maturity
      • Packages and platforms

    API Reference

    • Reified.Constraint
      • Catalogue
        • Operations
          • keys
          • arguments
          • english
          • pluralArgument
      • Constraint
        • Operations
          • satisfies
          • check
          • guard
          • inspect
          • all
          • any
          • notWith
          • custom
          • customLocalized
          • customLocalizedWith
          • customWith
          • contramap
          • describe
          • present
          • blank
          • optional
          • length
          • minLength
          • maxLength
          • lengthBetween
          • single
          • atLeastOne
          • atMostOne
          • moreThanOne
          • emailPattern
          • numericPattern
          • nonBlankPattern
          • trimmedPattern
          • email
          • trimmed
          • numeric
          • alphanumeric
          • pattern
          • relationWith
          • withinWith
          • oneOfWith
          • noneOfWith
          • checkBounds
          • equalTo
          • notEqualTo
          • greaterThan
          • lessThan
          • atLeast
          • atMost
          • between
          • positive
          • nonNegative
          • negative
          • nonPositive
          • oneOf
          • noneOf
          • containsWith
          • notContainsWith
          • uniquenessWith
          • containsIn
          • excludesIn
          • firstDuplicate
          • contains
          • notContains
          • distinct
          • multipleOfWith
          • multipleOf
          • finite
          • finite32
        • BlankDispatcher
          • Operations
            • Create
            • Create
            • Create
            • Create
            • Create
            • Create
            • Create
        • CardinalityDispatcher
          • Operations
            • Create
            • Create
            • Create
            • Create
        • ContainsDispatcher
          • Operations
            • Create
            • Create
            • Create
        • DistinctDispatcher
          • Operations
            • Create
            • Create
            • Create
        • MultipleOfDispatcher
          • Operations
            • Create
            • Create
            • Create
            • Create
            • Create
            • Create
        • NotContainsDispatcher
          • Operations
            • Create
            • Create
            • Create
        • OptionalDispatcher
          • Operations
            • Create
            • Create
            • Create
        • PresentDispatcher
          • Operations
            • Create
            • Create
            • Create
            • Create
            • Create
            • Create
            • Create
      • ConstraintAtom
        • Operations
          • key
          • arguments
          • render
      • ConstraintDSL
        • Operations
          • present
          • blank
          • optional
          • minLength
          • maxLength
          • lengthBetween
          • email
          • trimmed
          • numeric
          • alphanumeric
          • pattern
          • oneOf
          • noneOf
          • equalTo
          • notEqualTo
          • greaterThan
          • lessThan
          • atLeast
          • atMost
          • positive
          • nonNegative
          • negative
          • nonPositive
          • single
          • atLeastOne
          • atMostOne
          • moreThanOne
          • notContains
          • multipleOf
          • finite
          • finite32
          • notWith
          • custom
          • customLocalized
          • customWith
          • contramap
          • describe
          • orError
          • mapError
      • ConstraintDescription
        • Operations
          • children
          • isOpaque
          • atoms
      • ConstraintValue
        • Operations
          • ofFloat
          • ofFloat32
          • tryCreate
          • ofOperand
          • render
      • ConstraintValueInternals
        • Operations
          • tryOfObj
      • MessageDescriptor
        • Operations
          • key
          • arguments
          • segments
        • Advanced
          • Operations
            • tryCreate
            • create
            • ofSegments
      • MessageFormatSpec
        • Operations
          • descriptor
          • fallback
          • pluralArgument
        • Advanced
          • Operations
            • tryCreate
            • create
      • Renderer
        • Operations
          • english
          • ofLookup
          • ofResourceManager
          • ofResourceManagerWithCultures
          • ofCurrentCulture
          • context
          • attribute
          • unscoped
          • withValues
          • attributeName
          • fullMessage
        • Advanced
          • Operations
            • ofResolver
            • withValueFormatting
            • attributePath
            • lookupCandidates
            • messageRequests
            • attributeCandidates
            • format
      • UnsupportedOperation
        • Operations
          • key
          • render
      • Violation
        • Operations
          • described
          • conjoin
          • alternatives
          • children
          • flatten
          • tryExpectation
          • tryActual
          • tryDescription
          • tryDescriptionKey
          • render
          • toMessageTree
          • renderWith
          • message
          • fullMessage
      • AtomicViolation
        • Union cases
          • IsExpected
          • IsUnsupportedOperand
          • IsDescribed
          • Expected
          • Described
          • UnsupportedOperand
      • Cardinality
        • Union cases
          • IsMinimum
          • IsMaximum
          • IsExact
          • IsBetween
          • Exact
          • Minimum
          • Maximum
          • Between
      • Constraint<'value>
      • ConstraintAtom
        • Union cases
          • IsPresenceAtom
          • IsRelationAtom
          • IsUniquenessAtom
          • IsCardinalityAtom
          • IsMembershipAtom
          • IsNumberAtom
          • IsFormatAtom
          • PresenceAtom
          • CardinalityAtom
          • RelationAtom
          • MembershipAtom
          • UniquenessAtom
          • FormatAtom
          • NumberAtom
      • ConstraintDescription
        • Representation
          • Description
          • Expression
      • ConstraintExpression
        • Union cases
          • IsOptional
          • IsOpaque
          • IsAll
          • IsAny
          • IsAtom
          • Atom
          • All
          • Any
          • Optional
          • Opaque
      • ConstraintValue
        • Union cases
          • IsList
          • IsChar
          • IsGuid
          • IsDateTime
          • IsBigInteger
          • IsFloat
          • IsDateTimeOffset
          • IsBoolean
          • IsDecimal
          • IsFloat32
          • IsInteger
          • IsNull
          • IsText
          • IsTimeSpan
          • Text
          • Char
          • Integer
          • BigInteger
          • Decimal
          • Float
          • Float32
          • Boolean
          • Guid
          • DateTime
          • DateTimeOffset
          • TimeSpan
          • Null
          • List
      • Format
        • Union cases
          • IsTrimmed
          • IsNumeric
          • IsEmail
          • IsAlphanumeric
          • IsPattern
          • Email
          • Trimmed
          • Numeric
          • Alphanumeric
          • Pattern
      • Membership
        • Union cases
          • IsNotContains
          • IsOneOf
          • IsContains
          • IsNoneOf
          • OneOf
          • NoneOf
          • Contains
          • NotContains
      • MessageDescriptor
        • Representation
          • Segments
          • Values
      • MessageFormatSpec
        • Representation
          • Descriptor
          • Fallback
          • Plural
      • MessageFormatSpecError
        • Union cases
          • UnknownPluralArgument
      • MessageKeyError
        • Union cases
          • IsEmptyKey
          • IsEmptySegment
          • EmptyKey
          • EmptySegment
      • MessageLeaf
        • Union cases
          • IsLocalized
          • IsVerbatim
          • Localized
          • Verbatim
      • MessageLookup
      • MessageRequest
        • Representation
          • BaseKey
          • Arguments
          • PluralArgument
      • MessageResolution
        • Union cases
          • IsRendered
          • IsTemplate
          • Template
          • Rendered
      • MessageResolver
      • MessageTree
        • Union cases
          • IsLeaf
          • IsAll
          • IsAny
          • Leaf
          • All
          • Any
      • Number
        • Union cases
          • IsMultipleOf
          • IsFinite
          • MultipleOf
          • Finite
      • OpaqueConstraint
        • Union cases
          • IsRuntimeNegation
          • IsUnsupportedOperand
          • IsCustomPredicate
          • IsRuntimeProjection
          • CustomPredicate
          • RuntimeNegation
          • RuntimeProjection
          • UnsupportedOperand
      • PortableFloat
        • Representation
          • Value
      • PortableFloat32
        • Representation
          • Value
      • Presence
        • Union cases
          • IsPresent
          • IsBlank
          • Present
          • Blank
      • Relation
        • Union cases
          • IsWithin
          • IsCompared
          • Compared
          • Within
      • RelationOperator
        • Union cases
          • IsEqual
          • IsAtLeast
          • IsGreaterThan
          • IsNotEqual
          • IsAtMost
          • IsLessThan
          • Equal
          • NotEqual
          • GreaterThan
          • LessThan
          • AtLeast
          • AtMost
      • Renderer
      • UnsupportedOperation
        • Union cases
          • IsWithin
          • IsMultipleOf
          • IsRelation
          • IsContains
          • Relation
          • Within
          • Contains
          • MultipleOf
      • ValueFormatRequest
        • Representation
          • Value
          • Format
      • Violation
        • Union cases
          • IsAtomic
          • IsAll
          • IsAny
          • Atomic
          • All
          • Any
    • Reified.Data
      • Data
        • Operations
          • assoc
          • optionalAssoc
          • data
          • fields
          • number
          • objectOfMap
          • objectOfList
          • ofMap
          • ofDictionary
          • ofNameValues
          • ofNameValueCollection
          • ofCliArgs
          • ofJsonElement
          • ofJsonDocument
          • ofConfiguration
          • ofConfigurationPairs
          • tryFind
          • lookup
          • tryFindPath
          • lookupPath
          • tryRedisplay
          • redisplay
          • tryRedisplayAt
          • redisplayAt
          • tryRedisplayPath
          • redisplayPath
          • tryPatch
          • patch
          • applyEdit
          • set
          • replace
          • remove
          • append
          • prepend
          • insert
          • rename
          • update
          • diff
          • compare
          • tryMatch
          • render
          • renderIndented
          • tryText
          • tryBool
          • tryNumberToken
          • tryList
          • tryObject
        • Json
          • Operations
            • render
            • renderIndented
      • DataDSL
        • Operations
          • (=>)
          • (?=>)
          • nil
          • num
          • data
          • fields
          • set
          • replace
          • remove
          • append
          • prepend
          • insert
          • rename
          • update
          • variant
          • variants
          • dimension
          • matrix
          • exactly
          • containing
          • containingItems
          • inOrder
          • allItems
          • someItem
          • any
          • anyText
          • anyNumber
          • oneOf
          • satisfying
          • at
          • absent
          • matching
      • DataEdit
        • Operations
          • set
          • replace
          • remove
          • append
          • prepend
          • insert
          • rename
          • update
      • DataErgonomicsHelpers
        • Operations
          • toPatternWith
          • toPattern
          • exactValue
          • ensureText
          • ensureNonEmptyText
          • isJsonNumberToken
          • appendPath
          • shapeName
          • tryResolveDetailed
      • DataPath
        • Operations
          • empty
          • name
          • index
          • appendName
          • appendIndex
          • ofSegments
          • segments
          • toString
          • tryParse
          • parse
      • Data
        • Union cases
          • IsList
          • IsObject
          • IsBool
          • IsNumber
          • IsNull
          • IsText
          • From
          • From
          • From
          • From
          • From
          • From
          • From
          • From
          • From
          • From
          • From
          • Null
          • Text
          • Number
          • Bool
          • List
          • Object
      • DataCase
        • Representation
          • Name
          • Value
      • DataDifference
        • Representation
          • Path
          • Expected
          • Actual
          • Cause
      • DataDifferenceCause
        • Union cases
          • IsMissing
          • IsDifferentValue
          • IsUnexpected
          • IsDifferentFieldName
          • IsDifferentShape
          • Missing
          • Unexpected
          • DifferentValue
          • DifferentShape
          • DifferentFieldName
      • DataDimension
        • Representation
          • Name
          • Variations
      • DataEdit
        • Operations
          • Path
          • CreateAppend
          • CreateInsert
          • CreatePrepend
          • CreateReplace
          • CreateSet
      • DataExpectation
        • Operations
          • Path
          • Create
      • DataField
        • Operations
          • Create
      • DataMatchException
        • Operations
          • ``.ctor``
          • Mismatches
      • DataMismatch
        • Representation
          • ExpectationIndex
          • Path
          • Expected
          • Actual
      • DataPatchException
        • Operations
          • ``.ctor``
          • Failures
      • DataPatchFailure
        • Representation
          • EditIndex
          • Path
          • Message
      • DataPath
      • DataPathSegment
        • Union cases
          • IsIndex
          • IsName
          • Name
          • Index
      • DataPattern
        • Operations
          • RequireExact
          • CreateEveryItem
          • CreateExact
          • CreateListContaining
          • CreateListInOrder
          • CreateSomeItem
      • DataVariation
        • Representation
          • Name
          • Edits
      • PatternConversion
        • Operations
          • ToPattern
          • ToPattern
          • ToPattern
          • ToPattern
          • ToPattern
          • ToPattern
          • ToPattern
          • ToPattern
          • ToPattern
          • ToPattern
          • ToPattern
          • ToPattern
          • ToPattern
          • ToPattern
          • ToPattern
          • ToPattern
          • ToPattern
          • ToPattern
          • ToPattern
          • ToPattern
          • ToPattern
          • ToPattern
          • ToPattern
    • Reified.Parse
      • Parse
        • Operations
          • int
          • long
          • decimal
          • float
          • bool
          • guid
          • dateTime
          • dateTimeOffset
          • dateOnly
          • timeOnly
          • enum
          • optional
          • optionalOr
          • intOption
          • boolOption
          • decimalOption
          • guidOption
          • intOrDefault
          • boolOrDefault
          • decimalOrDefault
      • ParseError
        • Union cases
          • IsOutOfRange
          • IsMissingValue
          • IsInvalidFormat
          • MissingValue
          • InvalidFormat
          • OutOfRange
    • Reified.Refinements
      • Bounded
        • Operations
          • clamp
          • create
          • refinement
          • value
          • bounds
          • isAtBound
          • map
          • withBounds
      • BoundedFloat
        • Operations
          • normalize
          • denormalize
      • DistinctList
        • Operations
          • refinement
          • toList
          • create
          • ofSeq
          • empty
          • length
          • contains
          • toMapBy
          • toMap
          • toSet
          • add
          • remove
          • union
          • intersect
          • difference
          • filter
          • map
          • choose
          • sort
          • sortBy
          • rev
          • truncate
          • isEmpty
          • tryHead
          • exists
          • forall
          • tryFind
          • tryPick
          • iter
          • fold
          • sum
          • sumBy
      • FiniteFloat
        • Operations
          • constraint'
          • refinement
          • value
          • create
          • ofFloat
          • zero
          • one
          • negate
          • abs
          • min
          • max
          • compare
          • average
          • sum
          • minimum
          • maximum
      • FiniteFloat32
        • Operations
          • constraint'
          • refinement
          • value
          • create
          • ofFloat32
          • negate
          • abs
          • min
          • max
          • toFiniteFloat
          • zero
          • one
          • compare
          • sum
          • minimum
          • maximum
      • Interval
        • Operations
          • singleton
          • between
          • create
          • lower
          • upper
          • toPair
          • isSingleton
          • contains
          • containsInterval
          • overlaps
          • intersect
          • union
          • span
          • extendTo
          • ofNonEmptyList
          • clamp
          • mapMonotonic
          • toConstraint
          • duration
          • widthInt
          • widthDecimal
          • refinement
      • NonBlankString
        • Operations
          • refinement
          • value
          • create
          • map
          • append
          • join
          • trim
          • toUpper
          • toLower
          • length
          • split
      • NonEmptyArray
        • Operations
          • singleton
          • ofArray
          • ofSeq
          • ofList
          • refinement
          • listRefinement
          • create
          • toArray
          • toList
          • toNonEmptyList
          • ofNonEmptyList
          • head
          • tail
          • last
          • length
          • map
          • mapi
          • append
          • rev
          • sort
          • sortBy
          • sortWith
          • reduce
          • fold
          • min
          • max
          • minBy
          • maxBy
          • filter
          • tryFilter
          • exists
          • forall
          • iter
          • consTo
          • indexed
          • collect
          • concat
          • sortDescending
          • distinct
          • zip
          • unzip
          • reduceBack
          • foldBack
          • partition
          • contains
          • tryFind
          • toSeq
          • traverseResult
          • sequenceResult
          • traverseOption
          • sequenceOption
          • groupBy
          • chunkBySize
          • sum
          • sumBy
          • average
          • averageBy
          • countBy
          • scan
          • scanBack
          • tryFindBack
          • tryFindIndex
          • tryPick
          • choose
          • tryChoose
          • tryItem
          • item
          • truncate
          • skip
          • pairwise
          • iteri
          • init
          • replicate
          • sortByDescending
          • distinctBy
          • allPairs
          • map2
      • NonEmptyList
        • Operations
          • singleton
          • init
          • replicate
          • cons
          • consTo
          • ofList
          • ofSeq
          • ofArray
          • refinement
          • create
          • toArray
          • toList
          • toSeq
          • head
          • tail
          • last
          • length
          • map
          • mapi
          • indexed
          • append
          • appendList
          • collect
          • concat
          • rev
          • sort
          • sortBy
          • sortWith
          • sortDescending
          • sortByDescending
          • distinct
          • distinctBy
          • allPairs
          • zip
          • map2
          • unzip
          • reduce
          • reduceBack
          • fold
          • foldBack
          • min
          • max
          • minBy
          • maxBy
          • sum
          • sumBy
          • average
          • averageBy
          • countBy
          • scan
          • scanBack
          • filter
          • tryFilter
          • partition
          • exists
          • forall
          • contains
          • tryFind
          • tryFindBack
          • tryFindIndex
          • tryPick
          • choose
          • tryChoose
          • tryItem
          • item
          • truncate
          • skip
          • pairwise
          • iter
          • iteri
          • groupBy
          • chunkBySize
          • traverseResult
          • sequenceResult
          • traverseOption
          • sequenceOption
      • Refine
        • Operations
          • nonBlankString
          • finiteFloat
          • finiteFloat32
          • unitInterval
          • interval
          • bounded
          • nonEmptyList
          • nonEmptyArray
          • distinctList
        • Character
          • Operations
            • isAsciiDigit
            • isAsciiHexDigit
            • isLowercase
            • isUppercase
            • isWhitespace
            • isControl
            • isNumeric
        • Choice
          • Operations
            • orElse
            • tryAny
        • Collection
          • Operations
            • nonEmptyListRefinement
            • nonEmptyArrayRefinement
            • nonEmptyArrayFromListRefinement
            • distinctListRefinement
            • nonEmptyList
            • nonEmptyArray
            • distinctList
        • Text
          • Operations
            • nonBlankStringRefinement
            • nonBlankString
      • Refinement
        • Operations
          • define
          • create
          • underlying
          • constraint'
      • UnitInterval
        • Operations
          • bounds
          • constraint'
          • refinement
          • value
          • create
          • zero
          • one
          • half
          • clamp
          • complement
          • multiply
          • min
          • max
          • saturatingAdd
          • saturatingSubtract
          • lerp
          • lerpInterval
          • inverseLerp
          • inverseLerpInterval
          • toFiniteFloat
      • Bounded<'value>
        • Representation
          • Value
          • Bounds
          • BoundedValue
          • BoundsValue
      • DateRange
      • DistinctList<'value>
        • Union cases
          • ToList
      • FiniteFloat
        • Union cases
          • Value
      • FiniteFloat32
        • Union cases
          • Value
      • Interval<'value>
        • Representation
          • Upper
          • Lower
          • LowerValue
          • UpperValue
      • NonBlankString
        • Union cases
          • Value
      • NonEmptyArray<'value>
        • Union cases
          • ToArray
          • Head
          • Tail
          • Length
      • NonEmptyList<'value>
        • Union cases
          • ToList
          • Head
          • Tail
          • NonEmpty
      • Refinement<'underlying, 'refined>
      • UnitInterval
        • Union cases
          • Value
    • Reified.Result
      • Result
        • Operations
          • ok
          • error
          • map
          • mapError
          • bind
          • orElseWith
          • orElse
          • okIf
          • failIf
          • require
          • orError
          • fromTry
          • fromChoice
          • fromOption
          • fromValueOption
          • toOption
          • toValueOption
          • defaultValue
          • tap
          • tapError
          • traverse
          • sequence
          • traverseAll
          • sequenceAll
    • Reified.Schema
      • Declare schemas
        • Schema
          • Primitive schemas
            • text
            • date
            • dateTime
            • guid
          • Collections and optional values
            • listWith
            • list
            • option
            • mapWith
            • mapWithKey
            • map
          • Transformations and invariants
            • tryConvert
            • convert
            • refine
            • validate
            • constrain
            • constrainAll
            • admit
          • Unions and recursion
            • defer
            • union
            • unionWith
            • enum
          • Boundary behavior and metadata
            • mustSupply
            • mayOmit
            • withFormat
            • describe
            • withDefault
            • format
            • description
            • defaultValue
            • constraints
            • supply
          • Operations
            • int
            • int64
            • decimal
            • float
            • bool
            • isRefined
            • primitiveKind
            • underlyingPrimitiveKind
            • rawConstraints
            • inspectUnderlying
            • allConstraints
            • defaults
            • constructorErrorAt
          • Parse and check
            • parseWith
            • parse
            • parseRetainingInput
            • parseWithOptions
            • check
          • Interpretation
            • compilePlan
        • SchemaDSL
          • Operations
            • schema
            • case
            • tryExtract
            • fieldAs
            • construct
            • constructResult
            • constrainItems
            • constrainValues
        • Field
          • Operations
            • create
            • externalName
            • aliases
            • withAlias
            • withAliases
            • order
            • getValue
            • constraints
            • supply
            • withConstraint
            • withConstraints
        • field<'model, 'target>
          • Operations
            • ``.ctor``
            • ``.ctor``
            • Alias
            • Alias
            • Alias
            • Alias
            • Aliases
            • Aliases
            • Aliases
            • Aliases
            • Constrain
            • Constrain
            • Constrain
            • Constraints
            • Constraints
            • Constraints
            • DefaultValue
            • DefaultValue
            • DefaultValue
            • Describe
            • Describe
            • Describe
            • Format
            • Format
            • Format
            • MayOmit
            • MustSupply
            • MustSupply
            • MustSupply
            • Refine
            • Refine
            • Run
            • Run
            • Run
            • Run
            • Validate
            • Validate
            • Validate
            • Validate
            • WithSchema
            • Yield
        • EnumCase
          • Operations
            • create
        • UnionCase
          • Operations
            • empty
            • value
            • fields
        • ExternalFieldName
          • Operations
            • Value
        • FieldOrder
          • Operations
            • Value
        • RefinedSchemas
          • Operations
            • nonBlankString
            • finiteFloat
            • unitInterval
            • nonEmptyList
            • nonEmptyArray
            • distinctList
            • interval
            • bounded
            • dateRange
        • SchemaDefaults
          • Operations
            • DistinctListWith
            • ListWith
            • MapWith
            • NonEmptyArrayWith
            • NonEmptyListWith
            • OptionWith
            • Resolve
            • Schema
            • Schema
            • Schema
            • Schema
            • Schema
            • Schema
            • Schema
            • Schema
            • Schema
            • Schema
            • Schema
            • Schema
            • Schema
            • Schema
            • Schema
            • Schema
            • Schema
            • Schema
        • SchemaFormat
          • Operations
            • Name
        • Supply
          • Union cases
            • IsSupplied
            • IsOmittable
            • Supplied
            • Omittable
        • UnionRepresentation
          • Union cases
            • IsExternal
            • IsInternal
            • IsAdjacent
            • Internal
            • Adjacent
            • External
        • UnionRepresentations
          • Operations
            • recommended
            • fsharpSystemTextJsonDefault
            • fsharpSystemTextJsonInternalNamed
            • fsharpSystemTextJsonExternalNamed
            • reifiedAdjacent
            • compactExternal
        • UnionPayloadStyle
          • Union cases
            • IsPositional
            • IsUnwrappedSingle
            • IsPositionalWithUnwrappedSingle
            • IsNamedWithUnwrappedSingle
            • IsNamed
            • Named
            • Positional
            • UnwrappedSingle
            • NamedWithUnwrappedSingle
            • PositionalWithUnwrappedSingle
        • IRecordPlanCompiler<'model, 'result>
          • Operations
            • OnComplete
            • OnEnd
            • OnField
        • IRecordPlanState<'model, 'constructorIn, 'constructorOut>
          • Operations
            • Value
      • Parse and validate
        • SchemaError
          • Union cases
            • IsExpectedScalar
            • IsBlank
            • IsExpectedMany
            • IsExpectedObject
            • IsUnknownTag
            • IsConstructorFailed
            • IsOmitted
            • IsCustom
            • IsViolation
            • IsInvalidFormat
            • IsParseOutOfRange
            • Omitted
            • Blank
            • ExpectedScalar
            • ExpectedObject
            • ExpectedMany
            • InvalidFormat
            • ParseOutOfRange
            • UnknownTag
            • Violation
            • ConstructorFailed
            • Custom
        • SchemaErrors
        • SchemaIssue
          • Representation
            • Path
            • Error
        • SchemaPath
        • SchemaParseOptions
          • Representation
            • ConstructorErrorPath
        • RetainedParseResult
          • Operations
            • create
            • renderErrors
        • SchemaCheck
          • Operations
            • fromUnderlying
            • complete
            • text
            • ordered
        • SchemaMessages
          • Operations
            • keys
            • arguments
            • english
        • SchemaValidation
          • Operations
            • packageName
      • Interpret schemas
        • Inspect
          • Model inspection
            • model
            • field
          • Value inspection
            • schema
        • Json
          • Compile codecs
            • compile
          • Serialize JSON
            • serialize
            • serializeBytes
            • serializeWith
            • serializeBytesWith
            • serializeIndented
            • serializeToStream
            • serializeToStreamWith
          • Deserialize JSON
            • parseData
            • deserializeBytes
            • deserialize
            • tryDeserialize
            • deserializeStreamAsync
          • Formatting options
            • defaults
            • indented
            • reindent
          • Operations
            • tryParseData
        • JsonCodec<'model>
        • JsonCodecException
          • Operations
            • ``.ctor``
            • Path
            • Detail
        • JsonIndent
          • Union cases
            • IsSpaces
            • IsNone
            • IsTab
            • None
            • Spaces
            • Tab
        • JsonLineEnding
          • Union cases
            • IsCrLf
            • IsLf
            • Lf
            • CrLf
        • JsonWriteOptions
          • Representation
            • Indent
            • TrailingNewline
            • LineEnding
            • AsciiOnly
            • EscapeHtml
        • JsonSchema
          • Model schemas
            • generate
          • Value schemas
            • generateValue
        • Contract
          • Operations
            • create
            • supersedes
            • build
            • parseVersion
            • parse
            • name
            • currentVersion
            • currentSchema
        • ContractBuilder<'model, 'current>
          • Representation
            • Name
            • CurrentVersion
            • CurrentSchema
            • Versions
        • ContractError
          • Union cases
            • IsParseFailed
            • IsMigration
            • IsVersionMissing
            • IsVersionTooNew
            • IsVersionUnrecognized
            • VersionMissing
            • VersionUnrecognized
            • VersionTooNew
            • ParseFailed
            • Migration
        • MigrationError
          • Union cases
            • IsRevalidationFailed
            • IsMigrationFailed
            • MigrationFailed
            • RevalidationFailed
        • VersionSource
          • Union cases
            • IsExternal
            • IsField
            • IsUnversionedMeans
            • Field
            • External
            • UnversionedMeans
      • Schema descriptions
        • ModelDescription
          • Representation
            • Fields
            • Description
        • FieldDescription
          • Representation
            • Name
            • Aliases
            • Order
            • Schema
            • Constraints
            • Supply
        • SchemaDescription
          • Representation
            • Shape
            • Format
            • Constraints
            • Supply
            • Description
            • Default
        • SchemaShape
          • Union cases
            • IsDeferred
            • IsMapOf
            • IsUnion
            • IsOptional
            • IsMany
            • IsRecursive
            • IsEnum
            • IsPrimitive
            • IsNested
            • IsRefined
            • Primitive
            • Refined
            • Nested
            • Many
            • Union
            • Enum
            • Optional
            • MapOf
            • Deferred
            • Recursive
        • PrimitiveValueKind
          • Union cases
            • IsInt64
            • IsGuid
            • IsDateTime
            • IsInt
            • IsFloat
            • IsBool
            • IsDate
            • IsDecimal
            • IsText
            • Text
            • Int
            • Int64
            • Decimal
            • Float
            • Bool
            • Date
            • DateTime
            • Guid
        • EnumCaseDescription
          • Representation
            • Tag
        • EnumDescription
          • Representation
            • Cases
        • UnionCaseDescription
          • Representation
            • Tag
            • Shape
        • UnionCaseShape
          • Union cases
            • IsFields
            • IsEmpty
            • IsValue
            • Empty
            • Value
            • Fields
        • UnionDescription
          • Representation
            • Representation
            • Cases
      • Generated schema declarations
        • AtLeastAttribute
          • Operations
            • ``.ctor``
            • ``.ctor``
            • Value
        • AtMostAttribute
          • Operations
            • ``.ctor``
            • ``.ctor``
            • Value
        • DefaultAttribute
          • Operations
            • ``.ctor``
            • ``.ctor``
            • ``.ctor``
            • ``.ctor``
            • Value
        • DeriveSchemaAttribute
          • Operations
            • ``.ctor``
            • Contract
            • Version
        • DeriveUnionAttribute
          • Operations
            • ``.ctor``
            • ``.ctor``
            • UnwrapFieldless
            • PayloadStyle
            • PayloadField
            • FullyQualified
            • Representation
            • Discriminator
        • DistinctAttribute
          • Operations
            • ``.ctor``
        • EmailAttribute
          • Operations
            • ``.ctor``
        • FormatAttribute
          • Operations
            • ``.ctor``
            • Format
        • GreaterThanAttribute
          • Operations
            • ``.ctor``
            • ``.ctor``
            • Value
        • LengthAttribute
          • Operations
            • ``.ctor``
            • Length
        • LengthBetweenAttribute
          • Operations
            • ``.ctor``
            • Minimum
            • Maximum
        • LessThanAttribute
          • Operations
            • ``.ctor``
            • ``.ctor``
            • Value
        • MaxAttribute
          • Operations
            • ``.ctor``
            • Size
        • MinAttribute
          • Operations
            • ``.ctor``
            • Size
        • MultipleOfAttribute
          • Operations
            • ``.ctor``
            • ``.ctor``
            • Value
        • PatternAttribute
          • Operations
            • ``.ctor``
            • Pattern
        • PresentAttribute
          • Operations
            • ``.ctor``
        • SchemaAliasAttribute
          • Operations
            • ``.ctor``
            • Name
        • SchemaConstructorAttribute
          • Operations
            • ``.ctor``
        • SchemaNameAttribute
          • Operations
            • ``.ctor``
            • Name
        • SuppliedAttribute
          • Operations
            • ``.ctor``
        • UnionPayloadStyleKind
          • Operations
            • Named
            • Positional
            • UnwrappedSingle
            • NamedWithUnwrappedSingle
            • PositionalWithUnwrappedSingle
        • UnionRepresentationKind
          • Operations
            • Internal
            • Adjacent
            • External
    • Reified.SchemaGen
      • Emitter
        • Operations
          • emit
      • FieldDecl
        • Operations
          • wireName
      • GenerationPipeline
        • Operations
          • generate
        • GeneratedFile
          • Representation
            • SourcePath
            • Content
      • Parser
        • Operations
          • parse
      • Records
        • Operations
          • parse
          • parseSet
      • Resolver
        • Operations
          • resolve
      • Annotation
        • Representation
          • AnnotationName
          • AnnotationValue
          • AnnotationLine
      • ConstraintDecl
        • Union cases
          • IsAtLeast
          • IsDistinct
          • IsMaxSize
          • IsExactLength
          • IsCheckRef
          • IsLessThan
          • IsMinSize
          • IsSupplied
          • IsPresent
          • IsAtMost
          • IsGreaterThan
          • IsMultipleOf
          • IsLengthRange
          • IsPattern
          • AtLeast
          • GreaterThan
          • AtMost
          • LessThan
          • MinSize
          • MaxSize
          • ExactLength
          • LengthRange
          • Present
          • Supplied
          • Pattern
          • MultipleOf
          • Distinct
          • CheckRef
      • ContractDecl
        • Representation
          • ContractName
          • QualifiedName
          • Version
          • Doc
          • Annotations
          • Fields
          • OwnsType
          • ExternalTypeName
          • Constructor
          • ContractLine
      • ContractDiagnostic
        • Representation
          • File
          • Line
          • Message
      • ContractFile
        • Representation
          • FilePath
          • Namespace
          • Module
          • DeclaredTypes
          • Contracts
      • ContractRef
        • Representation
          • RefName
          • RefVersion
      • ExternalEnumCase
        • Representation
          • EnumTag
          • EnumFsCase
      • ExternalUnionCase
        • Representation
          • ExtTag
          • ExtFsCase
          • ExtPayload
          • ExtLine
      • ExternalUnionField
        • Representation
          • ExtFieldName
          • ExtWireName
          • ExtFieldType
          • ExtOptional
      • ExternalUnionPayload
        • Union cases
          • IsExternalRecord
          • IsExternalFields
          • IsExternalEmpty
          • ExternalEmpty
          • ExternalRecord
          • ExternalFields
      • ExternalUnionRepresentation
        • Union cases
          • IsGeneratedInternal
          • IsGeneratedAdjacent
          • IsGeneratedExternal
          • GeneratedInternal
          • GeneratedAdjacent
          • GeneratedExternal
      • FieldDecl
        • Representation
          • FieldName
          • WireName
          • Aliases
          • Optional
          • FieldType
          • Constraints
          • Format
          • Default
          • Doc
          • Annotations
          • FieldLine
      • FieldType
        • Union cases
          • IsExternalUnion
          • IsUnionBlock
          • IsMapOf
          • IsListOf
          • IsReference
          • IsMapOfTransparentKey
          • IsPrimitive
          • IsLiteralUnion
          • IsExternalEnum
          • IsExternalTransparent
          • Primitive
          • Reference
          • ListOf
          • MapOf
          • MapOfTransparentKey
          • LiteralUnion
          • UnionBlock
          • ExternalEnum
          • ExternalTransparent
          • ExternalUnion
      • Literal
        • Union cases
          • IsLBool
          • IsLString
          • IsLInt
          • IsLDecimal
          • LString
          • LInt
          • LDecimal
          • LBool
      • PrimitiveType
        • Union cases
          • IsPDate
          • IsPDecimal
          • IsPGuid
          • IsPBool
          • IsPText
          • IsPDateTime
          • IsPInt
          • IsPEmail
          • PText
          • PInt
          • PDecimal
          • PBool
          • PDate
          • PDateTime
          • PGuid
          • PEmail
      • SchemaNaming
        • Union cases
          • IsVerbatim
          • IsSnakeCase
          • IsCamelCase
          • CamelCase
          • SnakeCase
          • Verbatim
      • UnionCaseDecl
        • Representation
          • CaseTag
          • CaseRef
          • CaseLine
    • Reified.Schema.Testing
      • SchemaGen
        • Operations
          • rawWith
          • raw
          • roundTripWith
          • roundTrip
          • model
      • SchemaGenerationError
        • Union cases
          • UnsupportedConstraint