ReifiedReified
  • Docs
  • Reference
  • Packages
  • GitHub
  • 0.6.1
    • 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

TestingNamespace

Contents

SchemaGenModuleSchemaGenerationErrorUnion

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
      • SchemaDSL
      • Input Sources
      • Field Blocks and Plain Functions
      • Redisplay And Field Errors
      • Construction Guarantees
      • Refined Schemas
      • Union Schemas
      • Advanced Union Handling
      • JSON Codecs
      • Derived Schemas
        • Derived Schemas
        • Build Generation
        • Derivation Attributes
        • Schema Inference
      • Versioned Contracts
      • 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
      • Localization
        • Localization
        • Context and fallback
        • Custom rules
        • Advanced rendering
        • The key catalogue
      • Adding a language
      • Fable support
      • Constraint tutorials
        • Constraint tutorials
        • Constraint and Result Tutorial
      • Introductory Reference App
    • 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
    • Comparisons
      • Comparisons
      • How it compares
      • vs FluentValidation
      • vs zod
      • FsToolkit.ErrorHandling
    • Notes
      • Notes
      • Benchmarks
      • Compiler-Directed, AOT, and Fable
      • 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
          • 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
          • IsBetween
          • IsMaximum
          • IsExact
          • IsMinimum
          • Exact
          • Minimum
          • Maximum
          • Between
      • Constraint<'value>
      • ConstraintAtom
        • Union cases
          • IsMembershipAtom
          • IsPresenceAtom
          • IsNumberAtom
          • IsRelationAtom
          • IsCardinalityAtom
          • IsUniquenessAtom
          • IsFormatAtom
          • PresenceAtom
          • CardinalityAtom
          • RelationAtom
          • MembershipAtom
          • UniquenessAtom
          • FormatAtom
          • NumberAtom
      • ConstraintDescription
        • Representation
          • Description
          • Expression
      • ConstraintExpression
        • Union cases
          • IsOpaque
          • IsOptional
          • IsAtom
          • IsAny
          • IsAll
          • Atom
          • All
          • Any
          • Optional
          • Opaque
      • ConstraintValue
        • Union cases
          • IsFloat
          • IsBigInteger
          • IsInteger
          • IsList
          • IsDateTimeOffset
          • IsChar
          • IsNull
          • IsTimeSpan
          • IsDecimal
          • IsGuid
          • IsDateTime
          • IsFloat32
          • IsBoolean
          • IsText
          • Text
          • Char
          • Integer
          • BigInteger
          • Decimal
          • Float
          • Float32
          • Boolean
          • Guid
          • DateTime
          • DateTimeOffset
          • TimeSpan
          • Null
          • List
      • Format
        • Union cases
          • IsNumeric
          • IsPattern
          • IsEmail
          • IsTrimmed
          • IsAlphanumeric
          • Email
          • Trimmed
          • Numeric
          • Alphanumeric
          • Pattern
      • Membership
        • Union cases
          • IsContains
          • IsOneOf
          • IsNoneOf
          • IsNotContains
          • OneOf
          • NoneOf
          • Contains
          • NotContains
      • MessageDescriptor
        • Representation
          • Segments
          • Values
      • MessageFormatSpec
        • Representation
          • Descriptor
          • Fallback
          • Plural
      • MessageFormatSpecError
        • Union cases
          • UnknownPluralArgument
      • MessageKeyError
        • Union cases
          • IsEmptySegment
          • IsEmptyKey
          • 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
          • IsAny
          • IsAll
          • Leaf
          • All
          • Any
      • Number
        • Union cases
          • IsMultipleOf
          • IsFinite
          • MultipleOf
          • Finite
      • OpaqueConstraint
        • Union cases
          • IsRuntimeNegation
          • IsRuntimeProjection
          • IsCustomPredicate
          • IsUnsupportedOperand
          • 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
          • IsGreaterThan
          • IsAtLeast
          • IsEqual
          • IsAtMost
          • IsNotEqual
          • IsLessThan
          • Equal
          • NotEqual
          • GreaterThan
          • LessThan
          • AtLeast
          • AtMost
      • Renderer
      • UnsupportedOperation
        • Union cases
          • IsContains
          • IsMultipleOf
          • IsWithin
          • IsRelation
          • Relation
          • Within
          • Contains
          • MultipleOf
      • ValueFormatRequest
        • Representation
          • Value
          • Format
      • Violation
        • Union cases
          • IsAtomic
          • IsAny
          • IsAll
          • 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
          • IsNumber
          • IsNull
          • IsObject
          • IsBool
          • 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
          • IsDifferentFieldName
          • IsUnexpected
          • IsDifferentShape
          • IsDifferentValue
          • 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
          • IsName
          • IsIndex
          • 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
          • enum
          • optional
          • optionalOr
          • intOption
          • boolOption
          • decimalOption
          • guidOption
          • intOrDefault
          • boolOrDefault
          • decimalOrDefault
      • ParseError
        • Union cases
          • IsOutOfRange
          • IsInvalidFormat
          • IsMissingValue
          • 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
          • Lower
          • Upper
          • LowerValue
          • UpperValue
      • NonBlankString
        • Union cases
          • Value
      • NonEmptyArray<'value>
        • Union cases
          • ToArray
          • Length
          • Tail
          • Head
      • NonEmptyList<'value>
        • Union cases
          • ToList
          • Tail
          • Head
          • 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
      • Contract
        • Operations
          • create
          • supersedes
          • build
          • parseVersion
          • parse
          • name
          • currentVersion
          • currentSchema
      • EnumCase
        • Operations
          • create
      • ExternalFieldName
        • Operations
          • create
          • value
      • Field
        • Operations
          • create
          • externalName
          • order
          • getValue
          • constraints
          • supply
          • withConstraint
          • withConstraints
      • FieldOrder
        • Operations
          • create
          • value
      • Inspect
        • Operations
          • model
          • schema
          • field
      • JsonSchema
        • Operations
          • generate
          • generateValue
      • RefinedSchemas
        • Operations
          • nonBlankString
          • finiteFloat
          • unitInterval
          • nonEmptyList
          • nonEmptyArray
          • distinctList
          • interval
          • bounded
          • dateRange
      • RetainedParseResult
        • Operations
          • create
          • renderErrors
      • Schema
        • Operations
          • text
          • int
          • int64
          • decimal
          • float
          • bool
          • date
          • dateTime
          • guid
          • listWith
          • list
          • option
          • mapWith
          • mapWithKey
          • map
          • defer
          • tryConvert
          • convert
          • refine
          • validate
          • union
          • unionWith
          • enum
          • constrain
          • constrainAll
          • mustSupply
          • mayOmit
          • withFormat
          • describe
          • withDefault
          • format
          • description
          • defaultValue
          • constraints
          • supply
          • isRefined
          • primitiveKind
          • underlyingPrimitiveKind
          • rawConstraints
          • inspectUnderlying
          • allConstraints
          • compilePlan
          • defaults
          • constructorErrorAt
          • parseWith
          • parse
          • parseRetainingInput
          • parseWithOptions
          • check
          • admit
      • SchemaCheck
        • Operations
          • fromUnderlying
          • complete
          • text
          • ordered
      • SchemaDSL
        • Operations
          • schema
          • fieldAs
          • construct
          • constructResult
          • constrainItems
          • constrainValues
      • SchemaError
        • Operations
          • ofParseError
          • render
      • SchemaErrors
        • Operations
          • toList
          • count
          • isEmpty
          • toString
          • messages
          • fullMessages
          • toStringWith
      • SchemaFormat
        • Operations
          • create
          • email
          • name
      • SchemaMessages
        • Operations
          • keys
          • arguments
          • english
      • SchemaPath
        • Operations
          • root
          • key
          • index
          • append
          • format
          • fold
      • SchemaValidation
        • Operations
          • packageName
      • UnionCase
        • Operations
          • empty
          • value
          • fields
      • UnionRepresentations
        • Operations
          • recommended
          • fsharpSystemTextJsonDefault
          • fsharpSystemTextJsonInternalNamed
          • fsharpSystemTextJsonExternalNamed
          • reifiedAdjacent
          • compactExternal
      • Contract<'model>
        • Representation
          • Name
          • CurrentVersion
          • CurrentSchema
          • Source
          • Versions
      • ContractBuilder<'model, 'current>
        • Representation
          • Name
          • CurrentVersion
          • CurrentSchema
          • Versions
      • ContractError
        • Union cases
          • IsVersionUnrecognized
          • IsVersionTooNew
          • IsParseFailed
          • IsVersionMissing
          • IsMigration
          • VersionMissing
          • VersionUnrecognized
          • VersionTooNew
          • ParseFailed
          • Migration
      • EnumCase<'enum>
      • EnumCaseDescription
        • Representation
          • Tag
      • EnumDescription
        • Representation
          • Cases
      • ExternalFieldName
        • Operations
          • Value
      • Field<'model, 'value>
      • FieldDescription
        • Representation
          • Name
          • Order
          • Schema
          • Constraints
          • Supply
      • FieldOrder
        • Operations
          • Value
      • IRecordPlanCompiler<'model, 'result>
        • Operations
          • OnComplete
          • OnEnd
          • OnField
      • IRecordPlanState<'model, 'constructorIn, 'constructorOut>
        • Operations
          • Value
      • MigrationError
        • Union cases
          • IsRevalidationFailed
          • IsMigrationFailed
          • MigrationFailed
          • RevalidationFailed
      • ModelDescription
        • Representation
          • Fields
          • Description
      • PrimitiveValueKind
        • Union cases
          • IsInt64
          • IsFloat
          • IsDate
          • IsInt
          • IsDecimal
          • IsGuid
          • IsDateTime
          • IsBool
          • IsText
          • Text
          • Int
          • Int64
          • Decimal
          • Float
          • Bool
          • Date
          • DateTime
          • Guid
      • RetainedParseResult<'value>
        • Representation
          • ErrorsFor
          • ErrorsFor
          • Value
          • Errors
          • IsValid
          • TryValue
          • Input
          • Result
      • Schema<'model>
      • 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
      • SchemaDescription
        • Representation
          • Shape
          • Format
          • Constraints
          • Supply
          • Description
          • Default
      • SchemaError
        • Union cases
          • IsExpectedScalar
          • IsCustom
          • IsParseOutOfRange
          • IsViolation
          • IsConstructorFailed
          • IsUnknownTag
          • IsExpectedObject
          • IsBlank
          • IsInvalidFormat
          • IsOmitted
          • IsExpectedMany
          • Omitted
          • Blank
          • ExpectedScalar
          • ExpectedObject
          • ExpectedMany
          • InvalidFormat
          • ParseOutOfRange
          • UnknownTag
          • Violation
          • ConstructorFailed
          • Custom
      • SchemaErrors
      • SchemaFormat
        • Operations
          • Name
      • SchemaIssue
        • Representation
          • Path
          • Error
      • SchemaParseOptions
        • Representation
          • ConstructorErrorPath
      • SchemaPath
      • SchemaShape
        • Union cases
          • IsRefined
          • IsMapOf
          • IsPrimitive
          • IsMany
          • IsOptional
          • IsRecursive
          • IsEnum
          • IsNested
          • IsDeferred
          • IsUnion
          • Primitive
          • Refined
          • Nested
          • Many
          • Union
          • Enum
          • Optional
          • MapOf
          • Deferred
          • Recursive
      • Supply
        • Union cases
          • IsSupplied
          • IsOmittable
          • Supplied
          • Omittable
      • UnionCase<'union>
      • UnionCaseDescription
        • Representation
          • Tag
          • Shape
      • UnionCaseShape
        • Union cases
          • IsFields
          • IsValue
          • IsEmpty
          • Empty
          • Value
          • Fields
      • UnionDescription
        • Representation
          • Representation
          • Cases
      • UnionPayloadStyle
        • Union cases
          • IsNamedWithUnwrappedSingle
          • IsNamed
          • IsUnwrappedSingle
          • IsPositional
          • IsPositionalWithUnwrappedSingle
          • Named
          • Positional
          • UnwrappedSingle
          • NamedWithUnwrappedSingle
          • PositionalWithUnwrappedSingle
      • UnionRepresentation
        • Union cases
          • IsAdjacent
          • IsExternal
          • IsInternal
          • Internal
          • Adjacent
          • External
      • VersionSource
        • Union cases
          • IsExternal
          • IsUnversionedMeans
          • IsField
          • Field
          • External
          • UnversionedMeans
      • field<'model, 'target>
        • Operations
          • ``.ctor``
          • 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
      • DerivedSchema
        • AtLeastAttribute
          • Operations
            • ``.ctor``
            • ``.ctor``
            • Value
        • AtMostAttribute
          • Operations
            • ``.ctor``
            • ``.ctor``
            • Value
        • DefaultAttribute
          • Operations
            • ``.ctor``
            • ``.ctor``
            • ``.ctor``
            • ``.ctor``
            • Value
        • DeriveSchemaAttribute
          • Operations
            • ``.ctor``
            • Version
            • Chain
        • DeriveUnionAttribute
          • Operations
            • ``.ctor``
            • ``.ctor``
            • PayloadStyle
            • PayloadField
            • Representation
            • Discriminator
            • UnwrapFieldless
        • DistinctAttribute
          • Operations
            • ``.ctor``
        • EmailAttribute
          • Operations
            • ``.ctor``
        • FormatAttribute
          • Operations
            • ``.ctor``
            • Format
        • GreaterThanAttribute
          • Operations
            • ``.ctor``
            • ``.ctor``
            • Value
        • LengthAttribute
          • Operations
            • ``.ctor``
            • Length
        • LengthBetweenAttribute
          • Operations
            • ``.ctor``
            • Maximum
            • Minimum
        • 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``
        • SchemaConstructorAttribute
          • Operations
            • ``.ctor``
        • SchemaNameAttribute
          • Operations
            • ``.ctor``
            • Name
        • SuppliedAttribute
          • Operations
            • ``.ctor``
        • UnionPayloadStyleKind
          • Operations
            • Named
            • Positional
            • UnwrappedSingle
            • NamedWithUnwrappedSingle
            • PositionalWithUnwrappedSingle
        • UnionRepresentationKind
          • Operations
            • Internal
            • Adjacent
            • External
    • Reified.Schema.Contracts
      • Emitter
        • Operations
          • emit
      • FieldDecl
        • Operations
          • wireName
      • Parser
        • Operations
          • parse
      • Records
        • Operations
          • parse
          • parseSet
      • Resolver
        • Operations
          • resolve
      • Annotation
        • Representation
          • AnnotationName
          • AnnotationValue
          • AnnotationLine
      • ConstraintDecl
        • Union cases
          • IsGreaterThan
          • IsAtLeast
          • IsSupplied
          • IsLengthRange
          • IsMultipleOf
          • IsPattern
          • IsCheckRef
          • IsDistinct
          • IsPresent
          • IsAtMost
          • IsExactLength
          • IsLessThan
          • IsMinSize
          • IsMaxSize
          • 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
          • 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
          • IsGeneratedExternal
          • IsGeneratedAdjacent
          • IsGeneratedInternal
          • GeneratedInternal
          • GeneratedAdjacent
          • GeneratedExternal
      • FieldDecl
        • Representation
          • FieldName
          • WireName
          • Optional
          • FieldType
          • Constraints
          • Format
          • Default
          • Doc
          • Annotations
          • FieldLine
      • FieldType
        • Union cases
          • IsLiteralUnion
          • IsMapOf
          • IsMapOfTransparentKey
          • IsPrimitive
          • IsReference
          • IsListOf
          • IsExternalUnion
          • IsExternalTransparent
          • IsExternalEnum
          • IsUnionBlock
          • Primitive
          • Reference
          • ListOf
          • MapOf
          • MapOfTransparentKey
          • LiteralUnion
          • UnionBlock
          • ExternalEnum
          • ExternalTransparent
          • ExternalUnion
      • Literal
        • Union cases
          • IsLInt
          • IsLBool
          • IsLString
          • IsLDecimal
          • LString
          • LInt
          • LDecimal
          • LBool
      • PrimitiveType
        • Union cases
          • IsPText
          • IsPDateTime
          • IsPDecimal
          • IsPDate
          • IsPBool
          • IsPGuid
          • IsPInt
          • IsPEmail
          • PText
          • PInt
          • PDecimal
          • PBool
          • PDate
          • PDateTime
          • PGuid
          • PEmail
      • SchemaNaming
        • Union cases
          • IsCamelCase
          • IsSnakeCase
          • IsVerbatim
          • CamelCase
          • SnakeCase
          • Verbatim
      • UnionCaseDecl
        • Representation
          • CaseTag
          • CaseRef
          • CaseLine
    • Reified.Schema.Json
      • Json
        • Operations
          • compile
          • serialize
          • serializeBytes
          • parseData
          • deserializeBytes
          • deserialize
          • tryDeserialize
          • serializeToStream
          • deserializeStreamAsync
      • JsonCodec<'model>
      • JsonCodecException
        • Operations
          • ``.ctor``
          • Path
          • Detail
    • Reified.Schema.Testing
      • SchemaGen
        • Operations
          • rawWith
          • raw
          • model
      • SchemaGenerationError
        • Union cases
          • UnsupportedConstraint