SchemaShapeUnion
PackageReified.Schema
Describes the shape of a value schema as inspectable metadata for non-validation interpreters.
Specification
Kind
Union
Members
20
Examples
0
IsUnionSignature
this.IsUnion
IsOptionalSignature
this.IsOptional
IsNestedSignature
this.IsNested
IsPrimitiveSignature
this.IsPrimitive
IsManySignature
this.IsMany
Summary
| Name | Signature | Synopsis |
|---|---|---|
| IsUnion | this.IsUnion | No description available. |
| IsOptional | this.IsOptional | No description available. |
| IsNested | this.IsNested | No description available. |
| IsPrimitive | this.IsPrimitive | No description available. |
| IsMany | this.IsMany | No description available. |
| IsDeferred | this.IsDeferred | No description available. |
| IsMapOf | this.IsMapOf | No description available. |
| IsRefined | this.IsRefined | No description available. |
| IsRecursive | this.IsRecursive | No description available. |
| IsEnum | this.IsEnum | No description available. |
| Primitive | Primitive kind | A primitive value of the supplied kind. |
| Refined | Refined underlying | A refined/domain value whose boundary representation is the supplied underlying description. |
| Nested | Nested model | A nested model value described by its own field descriptions. |
| Many | Many item | A collection value whose items share the supplied item description. |
| Union | Union union | A union with one resolved wire representation and semantic case descriptions. |
| Enum | Enum enum | A bare-string enum value with explicit case tags. |
| Optional | Optional payload | An optional value whose present payload is described by the supplied payload description. |
| MapOf | MapOf item | A dictionary value, keyed by text, whose entries share the supplied item description. |
| Deferred | Deferred(reference, value) | The first expansion of a deferred recursive value, identified within this inspection tree. |
| Recursive | Recursive reference | A reference back to an already-expanding deferred value. |
A primitive value of the supplied kind.
Parameters
| Name | Type | Description |
|---|---|---|
| kind | PrimitiveValueKind |
Returns
unit
A refined/domain value whose boundary representation is the supplied underlying description.
Parameters
| Name | Type | Description |
|---|---|---|
| underlying | SchemaDescription |
Returns
unit
A nested model value described by its own field descriptions.
Parameters
| Name | Type | Description |
|---|---|---|
| model | ModelDescription |
Returns
unit
A collection value whose items share the supplied item description.
Parameters
| Name | Type | Description |
|---|---|---|
| item | SchemaDescription |
Returns
unit
A union with one resolved wire representation and semantic case descriptions.
Parameters
| Name | Type | Description |
|---|---|---|
| union | UnionDescription |
Returns
unit
A bare-string enum value with explicit case tags.
Parameters
| Name | Type | Description |
|---|---|---|
| enum | EnumDescription |
Returns
unit
An optional value whose present payload is described by the supplied payload description.
Parameters
| Name | Type | Description |
|---|---|---|
| payload | SchemaDescription |
Returns
unit
A dictionary value, keyed by text, whose entries share the supplied item description.
Parameters
| Name | Type | Description |
|---|---|---|
| item | SchemaDescription |
Returns
unit
The first expansion of a deferred recursive value, identified within this inspection tree.
Parameters
| Name | Type | Description |
|---|---|---|
| reference | int | |
| value | SchemaDescription |
Returns
unit