Skip to main content

Module model

Module model 

Source
Expand description

Core record, command, event, field, and accessor model types.

Structs§

AccessError
Buffer access error used by generated readers.
Command
Runtime command value with kind, external sequence, external time, and payload.
CommandDefinition
Static definition for one command type.
EnumDecodeError
Error returned when an encoded enum discriminant is unknown.
EnumDefinition
Static definition for one generated repr(u8) enum.
EnumVariantDefinition
Static definition for one repr(u8) enum variant.
Event
Runtime event value emitted by a command transaction.
EventDefinition
Static definition for one event type.
EventFrame
Event plus committed transaction sequence.
FieldDefinition
Static definition for one schema field.
FixedBytes
Fixed-capacity byte value with a logical length.
PayloadFieldDefinition
Static definition for one command or event payload field.
PkBuilder
Incremental primary-key byte encoder.
RecordDefinition
Static definition for one record type.
RecordKey
Fully qualified record key used by runtime hosts.
Version
Two-component schema version.

Enums§

FieldType
Primitive field representation supported by StateVec schemas.

Constants§

RECORD_HEADER_SIZE
Number of bytes reserved by the runtime record header.

Traits§

CommandSchema
Trait implemented by generated command types.
EnumU8
Trait implemented by #[derive(EnumU8)].
EventSchema
Trait implemented by generated event types.
GeneratedCommandAccess
Generated typed accessors for command payloads.
GeneratedEventAccess
Generated typed accessors for event payloads.
GeneratedRecordAccess
Generated typed accessors for a fixed-layout record.
PkCodec
Primary-key encoding hook implemented by generated record types.
RecordSchema
Trait implemented by generated record types.

Functions§

read_bool
Reads a boolean from a fixed-layout buffer.
read_fixed_bytes
Reads a fixed-capacity byte field from a fixed-layout buffer.
read_i32_le
Reads a little-endian i32 from a fixed-layout buffer.
read_i64_le
Reads a little-endian i64 from a fixed-layout buffer.
read_u8
Reads a u8 from a fixed-layout buffer.
read_u16_le
Reads a little-endian u16 from a fixed-layout buffer.
read_u32_le
Reads a little-endian u32 from a fixed-layout buffer.
read_u64_le
Reads a little-endian u64 from a fixed-layout buffer.
read_u128_le
Reads a little-endian u128 from a fixed-layout buffer.
read_var_bytes
Reads a payload-layer variable byte field and returns the field plus next offset.
write_bool
Writes a boolean into a fixed-layout buffer.
write_fixed_bytes
Writes a fixed-capacity byte field into a fixed-layout buffer.
write_i32_le
Writes a little-endian i32 into a fixed-layout buffer.
write_i64_le
Writes a little-endian i64 into a fixed-layout buffer.
write_u8
Writes a u8 into a fixed-layout buffer.
write_u16_le
Writes a little-endian u16 into a fixed-layout buffer.
write_u32_le
Writes a little-endian u32 into a fixed-layout buffer.
write_u64_le
Writes a little-endian u64 into a fixed-layout buffer.
write_u128_le
Writes a little-endian u128 into a fixed-layout buffer.
write_var_bytes
Appends a payload-layer variable byte field.

Type Aliases§

PkBytes
Encoded primary-key bytes.
PkEncodeFn
Function pointer used by generated record schemas to encode primary keys.
RecordKind
Stable numeric kind assigned to a record type within a schema version.
SysId
Host-assigned system identifier for one materialized record.
TxSeq
Monotonic committed transaction sequence.