Skip to main content

Module control

Module control 

Source
Expand description

Mutable namespace control-object envelopes and payloads.

Structs§

AcquiredWriter
Captures the writer identity and fencing epoch a session must retain while publishing.
CheckpointRecordState
A checkpoint record: pins one metadata manifest (its basis) so garbage collection keeps everything the manifest references.
ControlObjectEnvelope
In-memory view of a control object envelope.
ForkBasis
Where a fork target’s metadata basis lives before the target publishes its own manifest, and the permanent record of what it was forked from.
HeadIdentityDrift
A successor head changed one of the namespace’s immutable identity fields. Every head a namespace ever publishes carries them forward verbatim from the head that created it.
HeadState
Carries the authoritative visibility, allocation, and fencing state of a namespace.
MetadataRootState
Cold pointer to the best known materialized metadata root.
UploadSessionState
Tracks one durable content-upload workflow independently of commit publication.
WalFloorState
Lower bound of retained WAL/change history: the symmetrical pair to wal/head.json.
WalSegmentPointer
Links one accepted WAL segment to its immutable object and verified sequence range.
WriterBlock
Who most recently acquired the writer epoch, and when.

Enums§

CheckpointOwner
Durable owner of a checkpoint record: the party whose lifecycle decides when the pin is released.
CheckpointRecordLifecycle
Lifecycle of a durable checkpoint record: monotonic, with exactly two states and one transition.
ControlObjectKind
Selects one independently versioned mutable control-object family.
NamespaceState
Lifecycle state recorded in the namespace head.
UploadSessionLifecycle
Lifecycle of a durable upload session: one live state and two terminal ones, with no way back.
UploadSessionTransport
How one upload session moves its bytes into object storage, and everything that choice settles before any byte moves.

Functions§

control_payload_checksum
Computes the checksum stored beside canonical JSON for a control state.
decode_control_object
Decodes and verifies a durable JSON control object of expected_kind.
encode_control_object
Encodes a control-object envelope as its durable JSON representation.
genesis_commit_id
The commit id every namespace’s sequence zero carries, before any commit has landed.

Type Aliases§

CheckpointRecordEnvelope
Specializes a control envelope for a durable manifest pin.
HeadStateEnvelope
Specializes a control envelope for the authoritative namespace head.
MetadataRootEnvelope
Specializes a control envelope for the selected materialized manifest.
UploadSessionEnvelope
Specializes a control envelope for a durable upload workflow.
WalFloorEnvelope
Specializes a control envelope for the retained-history floor.