FieldDeclModule

PackageReified.Schema.Contracts
One declared contract field.

Summary

NameSignatureSynopsis
Representation
FieldNameFieldNameNo description available.
WireNameWireNameNo description available.
OptionalOptionalNo description available.
FieldTypeFieldTypeNo description available.
ConstraintsConstraintsNo description available.
FormatFormatOpen format metadata supplied by the record-attribute frontend.
DefaultDefaultNo description available.
DocDocNo description available.
AnnotationsAnnotationsNo description available.
FieldLineFieldLineNo description available.
Operations
wireNamewireName fieldThe external (wire) name: the explicit `as "..."` rename when present, the field name otherwise.

Representation

kind:member

FieldName

FieldName
Member

Returns

string
kind:member

WireName

WireName
Member

Returns

string option
kind:member

Optional

Optional
Member

Returns

bool
kind:member

FieldType

FieldType
Member

Returns

FieldType
kind:member

Constraints

Constraints
Member

Returns

(ConstraintDecl * int) list
kind:member

Format

Format
Member
Open format metadata supplied by the record-attribute frontend.

Returns

string option
kind:member

Default

Default
Member

Returns

Literal option
kind:member

Doc

Doc
Member

Returns

string list
kind:member

Annotations

Annotations
Member

Returns

Annotation list
kind:member

FieldLine

FieldLine
Member

Returns

int

Operations

kind:member

wireName

wireName field
Member
The external (wire) name: the explicit `as "..."` rename when present, the field name otherwise.

Parameters

NameTypeDescription
fieldFieldDecl

Returns

string