VersionSourceUnion

PackageReified.Schema

VersionSource

VersionSource is the explicit source of a contract version, chosen with Contract.build when a versioned contract is declared.

Source Use
VersionSource.Field "schemaVersion" Read a positive integer version from an input field.
VersionSource.External The caller knows the version out of band and calls Contract.parseVersion.
VersionSource.UnversionedMeans 1 Treat input without a marker as one registered version.

Contract.parse reads the declared source to select the frozen schema for the input version before parsing and migrating. See Versioned Contracts for the full workflow.

Specification

Kind
Union
Members
6
Examples
0
IsFieldSignature
this.IsField
IsExternalSignature
this.IsExternal
IsUnversionedMeansSignature
this.IsUnversionedMeans
FieldSignature
Field wireName
ExternalSignature
External

Summary

NameSignatureSynopsis
Union cases
IsFieldthis.IsFieldNo description available.
IsExternalthis.IsExternalNo description available.
IsUnversionedMeansthis.IsUnversionedMeansNo description available.
FieldField wireNameNo description available.
ExternalExternalNo description available.
UnversionedMeansUnversionedMeans versionNo description available.

Union cases

kind:member

IsField

this.IsField
Member

Returns

bool
kind:member

IsExternal

this.IsExternal
Member

Returns

bool
kind:member

IsUnversionedMeans

this.IsUnversionedMeans
Member

Returns

bool
kind:member

Field

Field wireName
Member

Parameters

NameTypeDescription
wireNamestring

Returns

unit
kind:member

External

External
Member

Returns

unit
kind:member

UnversionedMeans

UnversionedMeans version
Member

Parameters

NameTypeDescription
versionint

Returns

unit