Documentation
¶
Index ¶
- func CheckStructuralCompatibility(producer, consumer *Structure, limits StructuralLimits) error
- func CoerceContractFieldValidationRows(contract *Contract, rows []map[string]any) []map[string]any
- func CoerceDecimalRows(contract *Contract, rows []map[string]any) ([]map[string]any, error)
- func CollectColumnNames(rows []map[string]any) []string
- func ContractData(payload *Payload) ([]string, []map[string]any, error)
- func ContractHasFieldValidations(contract *Contract) bool
- func ContractValidationRuleStrings() []string
- func DecimalFieldCompatible(producer, consumer ContractField) bool
- func DecimalFieldValue(value any, field ContractField) (decimal.Value, error)
- func DetectJSONRootShape(body []byte) model.ContractRootShape
- func FieldPathExists(rows []map[string]any, fieldPath string) bool
- func InferContractField(rows []map[string]any, fieldName string) (model.ContractFieldType, bool)
- func InferFieldType(val any) model.ContractFieldType
- func MergeContractFieldType(current model.ContractFieldType, next model.ContractFieldType) model.ContractFieldType
- func MissingRequiredField(columnNames []string, rows []map[string]any, contract *Contract) (string, bool)
- func ParseCSVBodyToRows(body []byte) ([]map[string]any, []string, error)
- func ParseJSONBodyToRows(body []byte) ([]map[string]any, []string, error)
- func ParseJSONBodyToRowsPreserveNumbers(body []byte) ([]map[string]any, []string, error)
- func ProvenanceStrings() []string
- func ResolveFieldPathValues(root map[string]any, fieldPath string) ([]any, bool, bool, error)
- func StructuralCodeStrings() []string
- func StructuralKindStrings() []string
- func StructuralOpennessStrings() []string
- func StructuralSegmentKindStrings() []string
- func ValidateContractConjunction(a, b *Contract) error
- func ValidateContractFieldDeclarations(contract *Contract) error
- func ValidateDecimalFieldDeclaration(field ContractField) error
- func ValidateStructuralValue(s *Structure, value any, limits StructuralLimits) error
- func ValidateStructure(s *Structure, limits StructuralLimits) error
- func VerificationStatusStrings() []string
- type Contract
- type ContractField
- type ContractFieldValidationError
- type ContractFieldValidations
- type ContractValidationRule
- func (i ContractValidationRule) IsAContractValidationRule() bool
- func (i ContractValidationRule) MarshalJSON() ([]byte, error)
- func (i ContractValidationRule) MarshalText() ([]byte, error)
- func (i ContractValidationRule) String() string
- func (i *ContractValidationRule) UnmarshalJSON(data []byte) error
- func (i *ContractValidationRule) UnmarshalText(text []byte) error
- type Output
- type Payload
- type Provenance
- type StructuralCode
- func (i StructuralCode) IsAStructuralCode() bool
- func (i StructuralCode) MarshalJSON() ([]byte, error)
- func (i StructuralCode) MarshalText() ([]byte, error)
- func (i StructuralCode) String() string
- func (i *StructuralCode) UnmarshalJSON(data []byte) error
- func (i *StructuralCode) UnmarshalText(text []byte) error
- type StructuralDeclaration
- type StructuralError
- type StructuralKind
- func (i StructuralKind) IsAStructuralKind() bool
- func (i StructuralKind) MarshalJSON() ([]byte, error)
- func (i StructuralKind) MarshalText() ([]byte, error)
- func (i StructuralKind) String() string
- func (i *StructuralKind) UnmarshalJSON(data []byte) error
- func (i *StructuralKind) UnmarshalText(text []byte) error
- type StructuralLimits
- type StructuralLocator
- type StructuralMatch
- type StructuralOpenness
- func (i StructuralOpenness) IsAStructuralOpenness() bool
- func (i StructuralOpenness) MarshalJSON() ([]byte, error)
- func (i StructuralOpenness) MarshalText() ([]byte, error)
- func (i StructuralOpenness) String() string
- func (i *StructuralOpenness) UnmarshalJSON(data []byte) error
- func (i *StructuralOpenness) UnmarshalText(text []byte) error
- type StructuralPath
- type StructuralProperty
- type StructuralSegment
- type StructuralSegmentKind
- func (i StructuralSegmentKind) IsAStructuralSegmentKind() bool
- func (i StructuralSegmentKind) MarshalJSON() ([]byte, error)
- func (i StructuralSegmentKind) MarshalText() ([]byte, error)
- func (i StructuralSegmentKind) String() string
- func (i *StructuralSegmentKind) UnmarshalJSON(data []byte) error
- func (i *StructuralSegmentKind) UnmarshalText(text []byte) error
- type StructuralType
- type Structure
- type VerificationStatus
- func (i VerificationStatus) IsAVerificationStatus() bool
- func (i VerificationStatus) MarshalJSON() ([]byte, error)
- func (i VerificationStatus) MarshalText() ([]byte, error)
- func (i VerificationStatus) String() string
- func (i *VerificationStatus) UnmarshalJSON(data []byte) error
- func (i *VerificationStatus) UnmarshalText(text []byte) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CheckStructuralCompatibility ¶
func CheckStructuralCompatibility(producer, consumer *Structure, limits StructuralLimits) error
CheckStructuralCompatibility proves producer guarantees imply consumer requirements. Identity never substitutes for a matching literal data path.
func CoerceContractFieldValidationRows ¶
func CoerceContractFieldValidationRows( contract *Contract, rows []map[string]any, ) []map[string]any
CoerceContractFieldValidationRows converts serialized row values into declared scalar types for validation-only checks at string-backed boundaries such as CSV.
func CoerceDecimalRows ¶
CoerceDecimalRows binds declared decimals without changing other scalar semantics.
func CollectColumnNames ¶
func ContractHasFieldValidations ¶
ContractHasFieldValidations reports whether any field declares a validation rule that must be enforced at static or runtime contract boundaries.
func ContractValidationRuleStrings ¶
func ContractValidationRuleStrings() []string
ContractValidationRuleStrings returns a slice of all String values of the enum
func DecimalFieldCompatible ¶
func DecimalFieldCompatible(producer, consumer ContractField) bool
DecimalFieldCompatible proves that every producer value fits without rounding.
func DecimalFieldValue ¶
func DecimalFieldValue(value any, field ContractField) (decimal.Value, error)
DecimalFieldValue validates exact representability; rounding belongs in an explicit cast.
func DetectJSONRootShape ¶
func DetectJSONRootShape(body []byte) model.ContractRootShape
DetectJSONRootShape reports whether a JSON payload is a top-level object or array. Unknown is returned for empty, malformed, scalar, or null payloads.
func FieldPathExists ¶
FieldPathExists returns true when at least one row can resolve the full field path without missing any branch in that row.
func InferContractField ¶
func InferFieldType ¶
func InferFieldType(val any) model.ContractFieldType
InferFieldType maps a Go runtime value to the nearest ContractFieldType.
func MergeContractFieldType ¶
func MergeContractFieldType( current model.ContractFieldType, next model.ContractFieldType, ) model.ContractFieldType
func MissingRequiredField ¶
func ParseCSVBodyToRows ¶
ParseCSVBodyToRows decodes a CSV body into rows. The first row is treated as a header. Values are always strings.
func ParseJSONBodyToRows ¶
ParseJSONBodyToRows decodes a JSON body (array or object) into rows. Arrays produce one row per element; a top-level object produces a single row. Scalars, null, and malformed JSON are rejected as unsupported.
func ParseJSONBodyToRowsPreserveNumbers ¶
ParseJSONBodyToRowsPreserveNumbers decodes JSON rows while retaining json.Number values so callers can distinguish integer and decimal literals.
func ProvenanceStrings ¶
func ProvenanceStrings() []string
ProvenanceStrings returns a slice of all String values of the enum
func ResolveFieldPathValues ¶
ResolveFieldPathValues walks a field path through nested maps/arrays and returns all matched terminal values. It also reports whether the path existed and whether any branch had missing segments.
func StructuralCodeStrings ¶
func StructuralCodeStrings() []string
StructuralCodeStrings returns a slice of all String values of the enum
func StructuralKindStrings ¶
func StructuralKindStrings() []string
StructuralKindStrings returns a slice of all String values of the enum
func StructuralOpennessStrings ¶
func StructuralOpennessStrings() []string
StructuralOpennessStrings returns a slice of all String values of the enum
func StructuralSegmentKindStrings ¶
func StructuralSegmentKindStrings() []string
StructuralSegmentKindStrings returns a slice of all String values of the enum
func ValidateContractConjunction ¶
ValidateContractConjunction rejects provably disjoint declarations. It never merges promises: each declaration still requires its own runtime evaluation.
func ValidateContractFieldDeclarations ¶
ValidateContractFieldDeclarations checks that field validations are syntactically valid and compatible with their owning field and contract representation.
func ValidateDecimalFieldDeclaration ¶
func ValidateDecimalFieldDeclaration(field ContractField) error
func ValidateStructuralValue ¶
func ValidateStructuralValue(s *Structure, value any, limits StructuralLimits) error
ValidateStructuralValue checks one logical value without changing it. Encoding normalization and batch/root handling remain the caller's separate obligation.
func ValidateStructure ¶
func ValidateStructure(s *Structure, limits StructuralLimits) error
ValidateStructure rejects the entire tree on unsupported semantics or overflow.
func VerificationStatusStrings ¶
func VerificationStatusStrings() []string
VerificationStatusStrings returns a slice of all String values of the enum
Types ¶
type Contract ¶
type Contract struct {
Name string `json:"name" yaml:"name" validate:"required"`
Representation model.ContractRepresentation `json:"representation,omitempty" yaml:"representation,omitempty" validate:"omitempty,contractrepresentation"`
RootShape model.ContractRootShape `json:"root_shape,omitempty" yaml:"root_shape,omitempty" validate:"omitempty,contractrootshape"`
Fields []ContractField `json:"fields,omitempty" yaml:"fields,omitempty" validate:"omitempty,dive"`
}
func CloneContract ¶
type ContractField ¶
type ContractField struct {
Name string `json:"name" yaml:"name" validate:"required"`
Type model.ContractFieldType `json:"type" yaml:"type" validate:"required,contractfieldtype"`
Required bool `json:"required" yaml:"required"`
Nullable bool `json:"nullable,omitempty" yaml:"nullable,omitempty"`
Precision *int `json:"precision,omitempty" yaml:"precision,omitempty"`
Scale *int `json:"scale,omitempty" yaml:"scale,omitempty"`
Description string `json:"description,omitempty" yaml:"description,omitempty"`
Validations *ContractFieldValidations `json:"validations,omitempty" yaml:"validations,omitempty"`
}
func DeriveContractFields ¶
func DeriveContractFields(payload *Payload) []ContractField
type ContractFieldValidationError ¶
type ContractFieldValidationError struct {
ContractName string
FieldName string
Rule ContractValidationRule
ViolationCount int
}
ContractFieldValidationError summarizes a failed field validation without carrying payload values into logs, API responses, or persisted diagnostics.
func ValidateContractFieldValues ¶
func ValidateContractFieldValues( contract *Contract, rows []map[string]any, ) *ContractFieldValidationError
ValidateContractFieldValues checks runtime rows against declared field validations and returns the first safe failure summary.
func (*ContractFieldValidationError) Error ¶
func (f *ContractFieldValidationError) Error() string
func (ContractFieldValidationError) Summary ¶
func (f ContractFieldValidationError) Summary() string
Summary renders a safe operator-facing validation failure summary.
type ContractFieldValidations ¶
type ContractFieldValidations struct {
Format string `json:"format,omitempty" yaml:"format,omitempty"`
Enum []any `json:"enum,omitempty" yaml:"enum,omitempty"`
Min any `json:"min,omitempty" yaml:"min,omitempty"`
Max any `json:"max,omitempty" yaml:"max,omitempty"`
MinLength *int `json:"min_length,omitempty" yaml:"min_length,omitempty"`
MaxLength *int `json:"max_length,omitempty" yaml:"max_length,omitempty"`
Unique *bool `json:"unique,omitempty" yaml:"unique,omitempty"`
}
func CloneContractFieldValidations ¶
func CloneContractFieldValidations( validations *ContractFieldValidations, ) *ContractFieldValidations
func (*ContractFieldValidations) UnmarshalJSON ¶
func (v *ContractFieldValidations) UnmarshalJSON(data []byte) error
UnmarshalJSON preserves numeric validation literals exactly while leaving non-contract dynamic pipeline values on the default JSON decoding path.
func (*ContractFieldValidations) UnmarshalYAML ¶
func (v *ContractFieldValidations) UnmarshalYAML(value *yaml.Node) error
UnmarshalYAML rejects malformed validation rule declarations before zero values can make null rules indistinguishable from omitted rules.
type ContractValidationRule ¶
type ContractValidationRule int
ContractValidationRule identifies a supported field-level contract validation.
const ( ContractValidationRuleUnknown ContractValidationRule = iota // unknown ContractValidationRuleFormat // format ContractValidationRuleEnum // enum ContractValidationRuleMin // min ContractValidationRuleMax // max ContractValidationRuleMinLength // min_length ContractValidationRuleMaxLength // max_length ContractValidationRuleUnique // unique )
func ContractValidationRuleString ¶
func ContractValidationRuleString(s string) (ContractValidationRule, error)
ContractValidationRuleString retrieves an enum value from the enum constants string name. Throws an error if the param is not part of the enum.
func ContractValidationRuleValues ¶
func ContractValidationRuleValues() []ContractValidationRule
ContractValidationRuleValues returns all values of the enum
func (ContractValidationRule) IsAContractValidationRule ¶
func (i ContractValidationRule) IsAContractValidationRule() bool
IsAContractValidationRule returns "true" if the value is listed in the enum definition. "false" otherwise
func (ContractValidationRule) MarshalJSON ¶
func (i ContractValidationRule) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaler interface for ContractValidationRule
func (ContractValidationRule) MarshalText ¶
func (i ContractValidationRule) MarshalText() ([]byte, error)
MarshalText implements the encoding.TextMarshaler interface for ContractValidationRule
func (ContractValidationRule) String ¶
func (i ContractValidationRule) String() string
func (*ContractValidationRule) UnmarshalJSON ¶
func (i *ContractValidationRule) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaler interface for ContractValidationRule
func (*ContractValidationRule) UnmarshalText ¶
func (i *ContractValidationRule) UnmarshalText(text []byte) error
UnmarshalText implements the encoding.TextUnmarshaler interface for ContractValidationRule
type Output ¶
type Output struct {
OutputKind model.TransformOutputKind `json:"output_kind"`
RowCount int `json:"row_count"`
IsHeadlessCSV bool `json:"is_headless_csv,omitempty"`
ColumnNames []string `json:"column_names,omitempty"`
Rows []map[string]any `json:"rows,omitempty"`
Document json.RawMessage `json:"document,omitempty"`
CSV string `json:"csv,omitempty"`
}
type Payload ¶
type Payload struct {
Representation model.ContractRepresentation `json:"representation"`
RootShape model.ContractRootShape `json:"root_shape,omitempty"`
Contract *Contract `json:"contract,omitempty"`
VerificationStatus VerificationStatus `json:"verification_status,omitempty"`
Provenance Provenance `json:"provenance,omitempty"`
ColumnNames []string `json:"column_names,omitempty"`
RowCount int `json:"row_count,omitempty"`
Rows []map[string]any `json:"rows,omitempty"`
Document json.RawMessage `json:"document,omitempty"`
CSV string `json:"csv,omitempty"`
File *filepayload.FilePayloadMetadata `json:"file,omitempty"`
FileBytes []byte `json:"-" yaml:"-"`
Form *formpayload.FormData `json:"form,omitempty"`
}
type Provenance ¶
type Provenance int
const ( ProvenanceUnknown Provenance = iota // unknown ProvenanceExecutionResult // execution_result ProvenanceTransformOutput // transform_output ProvenanceRunInput // run_input )
func ProvenanceString ¶
func ProvenanceString(s string) (Provenance, error)
ProvenanceString retrieves an enum value from the enum constants string name. Throws an error if the param is not part of the enum.
func ProvenanceValues ¶
func ProvenanceValues() []Provenance
ProvenanceValues returns all values of the enum
func (Provenance) IsAProvenance ¶
func (i Provenance) IsAProvenance() bool
IsAProvenance returns "true" if the value is listed in the enum definition. "false" otherwise
func (Provenance) MarshalJSON ¶
func (i Provenance) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaler interface for Provenance
func (Provenance) MarshalText ¶
func (i Provenance) MarshalText() ([]byte, error)
MarshalText implements the encoding.TextMarshaler interface for Provenance
func (Provenance) String ¶
func (i Provenance) String() string
func (*Provenance) UnmarshalJSON ¶
func (i *Provenance) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaler interface for Provenance
func (*Provenance) UnmarshalText ¶
func (i *Provenance) UnmarshalText(text []byte) error
UnmarshalText implements the encoding.TextUnmarshaler interface for Provenance
type StructuralCode ¶
type StructuralCode int
const ( StructuralCodeUnknown StructuralCode = iota // unknown StructureInvalid // structure_invalid StructureUnsupported // structure_unsupported StructureLimit // structure_limit StructureAmbiguous // structure_ambiguous StructurePresence // structure_presence StructureNull // structure_null StructureType // structure_type StructureConstraint // structure_constraint StructureEncoding // structure_encoding )
func StructuralCodeString ¶
func StructuralCodeString(s string) (StructuralCode, error)
StructuralCodeString retrieves an enum value from the enum constants string name. Throws an error if the param is not part of the enum.
func StructuralCodeValues ¶
func StructuralCodeValues() []StructuralCode
StructuralCodeValues returns all values of the enum
func (StructuralCode) IsAStructuralCode ¶
func (i StructuralCode) IsAStructuralCode() bool
IsAStructuralCode returns "true" if the value is listed in the enum definition. "false" otherwise
func (StructuralCode) MarshalJSON ¶
func (i StructuralCode) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaler interface for StructuralCode
func (StructuralCode) MarshalText ¶
func (i StructuralCode) MarshalText() ([]byte, error)
MarshalText implements the encoding.TextMarshaler interface for StructuralCode
func (StructuralCode) String ¶
func (i StructuralCode) String() string
func (*StructuralCode) UnmarshalJSON ¶
func (i *StructuralCode) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaler interface for StructuralCode
func (*StructuralCode) UnmarshalText ¶
func (i *StructuralCode) UnmarshalText(text []byte) error
UnmarshalText implements the encoding.TextUnmarshaler interface for StructuralCode
type StructuralDeclaration ¶
type StructuralDeclaration struct {
Contract, Object, Revision string
ID, Identity string
Path StructuralPath
Locator StructuralLocator
Required bool
Type *StructuralType
// contains filtered or unexported fields
}
StructuralDeclaration separates revision identity, scoped continuity, and data path. These fields are protected inspection data, not safe error text.
type StructuralError ¶
type StructuralError struct {
Code StructuralCode
Locator StructuralLocator
}
func (*StructuralError) Error ¶
func (e *StructuralError) Error() string
type StructuralKind ¶
type StructuralKind int
StructuralKind is deliberately separate from the admitted flat contract syntax.
const ( StructuralKindUnknown StructuralKind = iota // unknown StructuralObject // object StructuralArray // array StructuralMap // map StructuralVector // vector StructuralString // string StructuralBoolean // boolean StructuralInteger // integer StructuralDecimal // decimal StructuralNumber // number StructuralDate // date StructuralLocalTime // local_time StructuralLocalDatetime // local_datetime StructuralInstant // instant )
func StructuralKindString ¶
func StructuralKindString(s string) (StructuralKind, error)
StructuralKindString retrieves an enum value from the enum constants string name. Throws an error if the param is not part of the enum.
func StructuralKindValues ¶
func StructuralKindValues() []StructuralKind
StructuralKindValues returns all values of the enum
func (StructuralKind) IsAStructuralKind ¶
func (i StructuralKind) IsAStructuralKind() bool
IsAStructuralKind returns "true" if the value is listed in the enum definition. "false" otherwise
func (StructuralKind) MarshalJSON ¶
func (i StructuralKind) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaler interface for StructuralKind
func (StructuralKind) MarshalText ¶
func (i StructuralKind) MarshalText() ([]byte, error)
MarshalText implements the encoding.TextMarshaler interface for StructuralKind
func (StructuralKind) String ¶
func (i StructuralKind) String() string
func (*StructuralKind) UnmarshalJSON ¶
func (i *StructuralKind) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaler interface for StructuralKind
func (*StructuralKind) UnmarshalText ¶
func (i *StructuralKind) UnmarshalText(text []byte) error
UnmarshalText implements the encoding.TextUnmarshaler interface for StructuralKind
type StructuralLimits ¶
type StructuralLimits struct{ Depth, Nodes, Bytes, Work int }
Limits may tighten these ceilings. Zero or larger limits fail closed.
func DefaultStructuralLimits ¶
func DefaultStructuralLimits() StructuralLimits
type StructuralLocator ¶
type StructuralLocator []int
StructuralLocator contains only schema positions, never payload keys/values, authored names, IDs, or free text. -1/-2/-3 locate items/keys/values.
type StructuralMatch ¶
type StructuralMatch struct {
Before, After *StructuralDeclaration
PathChanged bool
}
func MatchStructuralDeclarations ¶
func MatchStructuralDeclarations(before, after *Structure, limits StructuralLimits) ([]StructuralMatch, error)
MatchStructuralDeclarations supplies revision-impact primitives for known consumers. Nil sides mean removal/addition; no external consumer is inferred. Explicit IDs match only within contract/object/parent ancestry. ID-less declarations match exact unambiguous typed paths, never document positions.
type StructuralOpenness ¶
type StructuralOpenness int
const ( StructuralOpennessUnknown StructuralOpenness = iota // unknown StructuralOpen // open StructuralClosed // closed )
func StructuralOpennessString ¶
func StructuralOpennessString(s string) (StructuralOpenness, error)
StructuralOpennessString retrieves an enum value from the enum constants string name. Throws an error if the param is not part of the enum.
func StructuralOpennessValues ¶
func StructuralOpennessValues() []StructuralOpenness
StructuralOpennessValues returns all values of the enum
func (StructuralOpenness) IsAStructuralOpenness ¶
func (i StructuralOpenness) IsAStructuralOpenness() bool
IsAStructuralOpenness returns "true" if the value is listed in the enum definition. "false" otherwise
func (StructuralOpenness) MarshalJSON ¶
func (i StructuralOpenness) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaler interface for StructuralOpenness
func (StructuralOpenness) MarshalText ¶
func (i StructuralOpenness) MarshalText() ([]byte, error)
MarshalText implements the encoding.TextMarshaler interface for StructuralOpenness
func (StructuralOpenness) String ¶
func (i StructuralOpenness) String() string
func (*StructuralOpenness) UnmarshalJSON ¶
func (i *StructuralOpenness) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaler interface for StructuralOpenness
func (*StructuralOpenness) UnmarshalText ¶
func (i *StructuralOpenness) UnmarshalText(text []byte) error
UnmarshalText implements the encoding.TextUnmarshaler interface for StructuralOpenness
type StructuralPath ¶
type StructuralPath []StructuralSegment
func (StructuralPath) String ¶
func (p StructuralPath) String() string
String escapes literal names; ["a.b"] cannot alias ["a"]["b"]. Paths are for protected inspection, never ordinary diagnostics.
type StructuralProperty ¶
type StructuralProperty struct {
Name, ID string
Required bool
Type *StructuralType
}
type StructuralSegment ¶
type StructuralSegment struct {
Kind StructuralSegmentKind
Name string
}
type StructuralSegmentKind ¶
type StructuralSegmentKind int
const ( StructuralSegmentKindUnknown StructuralSegmentKind = iota // unknown StructuralPropertySegment // property StructuralItemSegment // item StructuralKeySegment // key StructuralValueSegment // value )
func StructuralSegmentKindString ¶
func StructuralSegmentKindString(s string) (StructuralSegmentKind, error)
StructuralSegmentKindString retrieves an enum value from the enum constants string name. Throws an error if the param is not part of the enum.
func StructuralSegmentKindValues ¶
func StructuralSegmentKindValues() []StructuralSegmentKind
StructuralSegmentKindValues returns all values of the enum
func (StructuralSegmentKind) IsAStructuralSegmentKind ¶
func (i StructuralSegmentKind) IsAStructuralSegmentKind() bool
IsAStructuralSegmentKind returns "true" if the value is listed in the enum definition. "false" otherwise
func (StructuralSegmentKind) MarshalJSON ¶
func (i StructuralSegmentKind) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaler interface for StructuralSegmentKind
func (StructuralSegmentKind) MarshalText ¶
func (i StructuralSegmentKind) MarshalText() ([]byte, error)
MarshalText implements the encoding.TextMarshaler interface for StructuralSegmentKind
func (StructuralSegmentKind) String ¶
func (i StructuralSegmentKind) String() string
func (*StructuralSegmentKind) UnmarshalJSON ¶
func (i *StructuralSegmentKind) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaler interface for StructuralSegmentKind
func (*StructuralSegmentKind) UnmarshalText ¶
func (i *StructuralSegmentKind) UnmarshalText(text []byte) error
UnmarshalText implements the encoding.TextUnmarshaler interface for StructuralSegmentKind
type StructuralType ¶
type StructuralType struct {
Kind StructuralKind
Nullable bool
Properties []StructuralProperty
Additional StructuralOpenness
Items *StructuralType
Keys *StructuralType
Values *StructuralType
// Integer bits are signed; number bits are IEEE binary32 or binary64.
Bits, Precision, Scale, Dimension int
Min, Max *decimal.Value
MinLength, MaxLength *int
Enum []any
Format string
// Unique applies to the immediate array's observed items, not external data.
Unique bool
}
type Structure ¶
type Structure struct {
Contract, Revision, Object string
Representation model.ContractRepresentation
RootShape model.ContractRootShape
Root *StructuralType
}
Structure is a resolved, runtime-neutral foundation for inline and ODCS compilers. It is not accepted by pipeline authoring or current execution.
type VerificationStatus ¶
type VerificationStatus int
const ( VerificationStatusUnknown VerificationStatus = iota // unknown VerificationStatusVerified // verified VerificationStatusTransitivelyVerified // transitively_verified VerificationStatusStaleIntrospection // stale_introspection VerificationStatusIncompatible // incompatible )
func VerificationStatusString ¶
func VerificationStatusString(s string) (VerificationStatus, error)
VerificationStatusString retrieves an enum value from the enum constants string name. Throws an error if the param is not part of the enum.
func VerificationStatusValues ¶
func VerificationStatusValues() []VerificationStatus
VerificationStatusValues returns all values of the enum
func (VerificationStatus) IsAVerificationStatus ¶
func (i VerificationStatus) IsAVerificationStatus() bool
IsAVerificationStatus returns "true" if the value is listed in the enum definition. "false" otherwise
func (VerificationStatus) MarshalJSON ¶
func (i VerificationStatus) MarshalJSON() ([]byte, error)
MarshalJSON implements the json.Marshaler interface for VerificationStatus
func (VerificationStatus) MarshalText ¶
func (i VerificationStatus) MarshalText() ([]byte, error)
MarshalText implements the encoding.TextMarshaler interface for VerificationStatus
func (VerificationStatus) String ¶
func (i VerificationStatus) String() string
func (*VerificationStatus) UnmarshalJSON ¶
func (i *VerificationStatus) UnmarshalJSON(data []byte) error
UnmarshalJSON implements the json.Unmarshaler interface for VerificationStatus
func (*VerificationStatus) UnmarshalText ¶
func (i *VerificationStatus) UnmarshalText(text []byte) error
UnmarshalText implements the encoding.TextUnmarshaler interface for VerificationStatus