Skip to main content

Module circle_control

Module circle_control 

Source
Expand description

Circle metadata, access records, controls, and creation objects.

Structs§

AccessEnvelopeBody
The wire body of one recipient’s access envelope. Every field here is signed.
ActiveCircleEpochCore
CircleAccessLeafBody
The wire body of one recipient’s Circle access leaf. Every field here is signed.
CircleBootstrapCoverageRef
The exact retained bootstrap coverage a recipient device’s live Circle projection was seeded from: the activating Store commit, the control it activated under, and the bootstrap reference (its exact cut and image hash live inside that reference, not re-declared here). Names one row of circle_bootstrap_coverage.
CircleBootstrapRef
Exact Circle database image offered when one recipient becomes active.
CircleControlBody
The wire body of one Circle control. Every field here is signed.
CircleControlCoord
Exact coordinate of one signed circle control entry.
CircleControlCoordError
CircleControlValue
CircleEpochClose
CircleEpochCloseCancellationRef
CircleEpochCloseExclusionRef
CircleEpochCloseIntentRef
CircleEpochCloseOutcomeRef
CircleEpochCloseParticipant
CircleEpochCloseResponseRef
CircleEpochSuccessor
CircleMetadataBody
The wire body of one Circle metadata entry. Every field here is signed.
CircleMetadataCoord
CircleMetadataHeadRef
CircleRosterPolicyObjects
CircleTransitionDraft
CircleTransitionDraftPolicy
CircleTransitionPolicyObjects
DeletedCircle
A terminal deletion. It freezes the epoch spine it terminated — the same MergeActiveCircleEpoch an EpochClose freezes — so historical package verification and exact reclamation keep the epoch, key fingerprint, and roster-head spine with no live access material.
MergeActiveCircleEpoch
MergeCircleControlHeadRef
MergeCircleControlOrder
MergeCircleMetadataStateRef
PreparedAccessLeaf
PreparedCircleAccess
PreparedCircleControl
PreparedCircleTransition
ResolvedConflictBranch
One losing branch of a resolved control conflict, carried so the resolution can cover every branch’s frontier rather than only the chosen branch’s: the branch’s control head, its metadata and roster head frontiers, and the metadata entry that branch selected. The resolution unions these into its own frontier so no author-stream head is re-allocated once the conflict collapses, and re-derives its name as the deterministic metadata selection across the union.
StoreMembershipStateRef
The exact Store membership state whose identities require access dispositions.

Enums§

CircleAccessDisposition
CircleControlState
CircleEpochCloseResponseSlotValue
The exactly-one value a participant’s create-once close-response slot holds: the device’s own signed response, or an Owner-signed exclusion of that device.
CircleEpochCloseSettlement
One participant’s contribution to a close outcome: either its verified device response (whose frontier joins the cutoff) or an Owner exclusion (which does not). The outcome carries one per participant.
CircleEpochCloseSlotValue
The exactly-one value the create-once epoch-close outcome slot holds. Readers parse this tagged form and dispatch on the settled arm: a final outcome rotates to a successor epoch, a cancellation reopens the frozen epoch.
CircleEpochOrigin
CircleRosterDraftPolicy
CircleSemanticSlot
CircleTransitionError
MergeCircleOwnerAuthorityRef
MerkleStep

Functions§

circle_control_head_prefix
circle_epoch_close_intent_semantic_prefix
circle_epoch_close_outcome_semantic_prefix
circle_epoch_close_response_semantic_prefix
circle_metadata_head_prefix
circle_roster_head_prefix
circle_semantic_prefix
merge_frontier_head
Insert head into a frontier keyed by author stream, keeping the deeper (higher-sequence) head when the stream already carries one. Merging every conflicting branch’s heads this way yields the union frontier: each stream is covered at its deepest position across all branches, so a device that authored on that stream continues from its own head instead of re-allocating it.
merkle_root_and_proofs
recipient_slot
recipient_slot_with_peer
verify_circle_semantic_prefix
verify_merkle_proof

Type Aliases§

AccessEnvelope
CircleAccessLeaf
CircleControl
CircleControlHead
CircleEpochCloseCancellation
CircleEpochCloseExclusion
CircleEpochCloseIntent
CircleEpochCloseOutcome
CircleEpochCloseResponse
CircleMetadata
CircleMetadataHead
CircleMetadataStateRef