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.
MetadataCompactionLeaseState
Says who owns the objects under one streaming metadata compaction’s job prefix.
MetadataRootState
Cold pointer to the best known materialized metadata root.
UploadSessionState
Tracks one durable content-upload workflow independently of commit publication.
WalFloorState
Earliest sequence for which incremental WAL history is retained.
WalSegmentPointer
Links one accepted WAL segment identity to its verified sequence range.
WriterBlock
Who most recently acquired the writer epoch, and when.

Enums§

CheckpointOwner
Durable owner and expiry policy of a checkpoint record.
CheckpointRecordLifecycle
Monotonic lifecycle of a durable checkpoint record.
ControlObjectKind
Selects one independently versioned mutable control-object family.
MetadataCompactionLeaseStatus
Lifecycle of a compaction lease: two states and one transition.
NamespaceState
Lifecycle state recorded in the namespace head.
ProxiedStaging
Staging progress for a service-proxied upload.
UploadSessionLifecycle
Monotonic lifecycle of a durable upload session.
UploadSessionTransport
The transport never changes, and each variant stores only the state required by that upload path.

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.
encode_control_state
Encodes state in a control-object envelope.
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.
MetadataCompactionLeaseEnvelope
Specializes a control envelope for a running compaction’s ownership of its staged output.
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.