SchemaShapeUnion

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

Specification

Kind
Union
Members
20
Examples
0
IsDeferredSignature
this.IsDeferred
IsPrimitiveSignature
this.IsPrimitive
IsUnionSignature
this.IsUnion
IsRecursiveSignature
this.IsRecursive
IsRefinedSignature
this.IsRefined

Summary

NameSignatureSynopsis
Union cases
IsDeferredthis.IsDeferredNo description available.
IsPrimitivethis.IsPrimitiveNo description available.
IsUnionthis.IsUnionNo description available.
IsRecursivethis.IsRecursiveNo description available.
IsRefinedthis.IsRefinedNo description available.
IsNestedthis.IsNestedNo description available.
IsEnumthis.IsEnumNo description available.
IsOptionalthis.IsOptionalNo description available.
IsManythis.IsManyNo description available.
IsMapOfthis.IsMapOfNo description available.
PrimitivePrimitive kindA primitive value of the supplied kind.
RefinedRefined underlyingA refined/domain value whose boundary representation is the supplied underlying description.
NestedNested modelA nested model value described by its own field descriptions.
ManyMany itemA collection value whose items share the supplied item description.
UnionUnion unionA union with one resolved wire representation and semantic case descriptions.
EnumEnum enumA bare-string enum value with explicit case tags.
OptionalOptional payloadAn optional value whose present payload is described by the supplied payload description.
MapOfMapOf itemA dictionary value, keyed by text, whose entries share the supplied item description.
DeferredDeferred(reference, value)The first expansion of a deferred recursive value, identified within this inspection tree.
RecursiveRecursive referenceA reference back to an already-expanding deferred value.

Union cases

kind:member

IsDeferred

this.IsDeferred
Member

Returns

bool
kind:member

IsPrimitive

this.IsPrimitive
Member

Returns

bool
kind:member

IsUnion

this.IsUnion
Member

Returns

bool
kind:member

IsRecursive

this.IsRecursive
Member

Returns

bool
kind:member

IsRefined

this.IsRefined
Member

Returns

bool
kind:member

IsNested

this.IsNested
Member

Returns

bool
kind:member

IsEnum

this.IsEnum
Member

Returns

bool
kind:member

IsOptional

this.IsOptional
Member

Returns

bool
kind:member

IsMany

this.IsMany
Member

Returns

bool
kind:member

IsMapOf

this.IsMapOf
Member

Returns

bool
kind:member

Primitive

Primitive kind
Member
A primitive value of the supplied kind.

Parameters

NameTypeDescription
kindPrimitiveValueKind

Returns

unit
kind:member

Refined

Refined underlying
Member
A refined/domain value whose boundary representation is the supplied underlying description.

Parameters

NameTypeDescription
underlyingSchemaDescription

Returns

unit
kind:member

Nested

Nested model
Member
A nested model value described by its own field descriptions.

Parameters

NameTypeDescription
modelModelDescription

Returns

unit
kind:member

Many

Many item
Member
A collection value whose items share the supplied item description.

Parameters

NameTypeDescription
itemSchemaDescription

Returns

unit
kind:member

Union

Union union
Member
A union with one resolved wire representation and semantic case descriptions.

Parameters

NameTypeDescription
unionUnionDescription

Returns

unit
kind:member

Enum

Enum enum
Member
A bare-string enum value with explicit case tags.

Parameters

NameTypeDescription
enumEnumDescription

Returns

unit
kind:member

Optional

Optional payload
Member
An optional value whose present payload is described by the supplied payload description.

Parameters

NameTypeDescription
payloadSchemaDescription

Returns

unit
kind:member

MapOf

MapOf item
Member
A dictionary value, keyed by text, whose entries share the supplied item description.

Parameters

NameTypeDescription
itemSchemaDescription

Returns

unit
kind:member

Deferred

Deferred(reference, value)
Member
The first expansion of a deferred recursive value, identified within this inspection tree.

Parameters

NameTypeDescription
referenceint
valueSchemaDescription

Returns

unit
kind:member

Recursive

Recursive reference
Member
A reference back to an already-expanding deferred value.

Parameters

NameTypeDescription
referenceint

Returns

unit