Module records

Expand description

Lace H3 record creation, validation, and metadata views.

Structs§

ApplicationFieldIter: Iterator over canonical Plex application fields.
BySecret: The single zeroizing owner for canonical private By-secret value (&.<b64a>.H3).
ByValue: Canonical record-facing By value (V.<b64a>.H3).
FieldOccurrence: One borrowed Plex application-field occurrence.
IndexedField: One indexed occurrence returned by direct field lookup.
Mark: A 64-byte Lace Schnorr-BLAKE3 signature, validated when verified.
Record: A validated record: verified canonical bytes from one retained source.
RecordHash
RecordMetadata: Borrowed view of a validated record’s canonical non-payload prefix.
RecordSpec: Application-facing record construction intent.
RecordValidator: Validates exactly one canonical record supplied in arbitrary fragments.
SigningKey: A normalized secret derived from Lace’s 32-byte seed (not a raw scalar). Secret storage is erased on drop, best effort; compiler copies may remain.
TypedH3Text
ValidatedHeader: The verified header of one complete record: outer hash, canonical length and the canonical non-payload prefix, whose length is the data offset.
VerificationKey: A validated x-only, even-y Lace verification key.

CryptoError
HashTextError
RecordCreateError: Error returned by application-facing record construction.
RecordError: Error type for record validation failures.
RecordKind: Record kind identified by the record glyph line.
RecordReadError: A record could not be materialised.
TypedTextError

BY_SECRET_TEXT_LEAD
BY_VALUE_TEXT_LEAD
LENGTH_FIELD: The 020 synthetic complete canonical record byte length field.
MAX_BLOB_RECORD_BYTES: Maximum complete canonical H3 Blob byte length.
MAX_BLOB_SIZE: Maximum Blob data size: 32 MiB.
MAX_FIELD_LINE_BYTES_EXCLUDING_LF: Maximum complete H3 field-line size in UTF-8 bytes, excluding LF.
MAX_H3_RECORD_BYTES: Maximum complete canonical H3 record byte length (a Seal over a maximum Plex).
MAX_PLEX_FIELDS: Maximum number of application field occurrences in one Plex.
MAX_PLEX_RECORD_BYTES: Maximum complete canonical H3 Plex byte length.
MAX_RECORD_METADATA_BYTES: Maximum canonical non-payload prefix (record metadata) of an H3 record: every byte of a maximum Seal except its Blob data.
RECORD_GLYPH: The Lace record glyph character at the start of every record glyph line.
RECORD_HASH_B64A_LEN
RECORD_HASH_TEXT_LEN
REGISTERED_TYPED_TEXT_LEADS
SYNTHETIC_FIELD_NAMES: Field names projected by 020 that never occur in record bytes.
TYPE_FIELD: The 020 synthetic record kind field: B, P, or S.

IntoRecordBatch: Convert owned or borrowed validated records into a store-operation batch.
IntoRecordData: Values accepted by RecordSpec::data and RecordSpec::from_data.

b64a_decode: Decode a B64A string into bytes. Validates canonical zeroed trailing bits.
b64a_decoded_len: Compute the decoded length for a valid B64A string length.
b64a_encode: Encode bytes as a B64A string.
b64a_encoded_len: Compute the encoded length for a given number of input bytes.
blake3_hash: Plain BLAKE3 hash of data.
generate_by_secret: Generate a canonical By-secret value from OS randomness.
is_synthetic_field_name: Whether a name is one of the 020 synthetic field names.
new_record: Construct and validate the one record kind implied by caller intent.
random_aux_rand32: Generate nonzero auxiliary randomness using the OS random source.
typed_text_lead_description: Human-readable owner for one registered typed-text lead byte.