Class

Required Rule

A rule that MUST be followed

Class
Subclass Of
Rule

Instances 9

Required RuleEmptyStructsAreVariantsOnlyA Variant MAY declare zero fields (a tag-only message). A standalone Struct declaration MUST declare at least one field.wire-form@1.0.0
Required RuleFieldOrderIsByteOrderThe wire.fields list order IS the byte layout. Implementations MUST encode and decode fields in list order with no padding, alignment, or reordering.wire-form@1.0.0
Required RuleFixedBytesRequiresLengthA field typed FixedBytes MUST carry wire.byteLength; any other field type MUST NOT.wire-form@1.0.0
Required RuleGenerateDontInterpretWire declarations MUST be realized as generated static codecs; implementations MUST NOT interpret declarations on the per-frame data path.wire-form@1.0.0
Required RuleJsonBodyRequiresSchemaA field typed JsonBody MUST carry wire.bodySchema; any other field type MUST NOT.wire-form@1.0.0
Required RuleKernelSemanticsPrimitive semantics are defined by the kanonak-wire runtime kernel at wireFormatVersion "1" (big-endian, strict UTF-8, lowercase UUID canonical form, fail-loud…wire-form@1.0.0
Required RuleLayoutVersioningWire messages carry no in-band version. Any change to a Declaration's layout (fields, order, types, tags, constants) MUST ship as a new package version, never…wire-form@1.0.0
Required RuleTagValuesUniqueAndInRangeWithin a Union, every Variant's tagValue MUST be unique and MUST fit the taggedBy primitive's value range. Decoders MUST fail loudly (UnknownTag) on an…wire-form@1.0.0
Required RuleTailTypesLastA field typed Rest or JsonBody MUST be the final field of its Struct or Variant, and at most one such field may appear.wire-form@1.0.0

Referenced by

← Range

Object PropertyHas Required RuleA required rule (MUST) that is part of this conventionprotocols@2.1.0