Struct CircleOperationJournal 

pub struct CircleOperationJournal {
    pub operation_id: CircleOperationId,
    pub circle_id: CircleId,
    pub intent: CircleOperationIntent,
    pub operation: PreparedCircleOperation,
    pub progress: CircleOperationProgress,
    pub uploaded: BTreeSet<String>,
}

One Circle operation as it stands right now: the identity and prepared operation held in circle_operations, the phase held beside them, and the upload steps already completed, joined from circle_operation_uploads.

The three parts have different lifetimes on disk, which is why they are stored apart: the operation is written once, the phase changes on transitions, and the upload steps accumulate one row at a time.

Fields

operation_id: CircleOperationId

circle_id: CircleId

intent: CircleOperationIntent

operation: PreparedCircleOperation

progress: CircleOperationProgress

uploaded: BTreeSet<String>

Implementations

impl CircleOperationJournal

pub fn ready( operation_id: CircleOperationId, circle_id: CircleId, intent: CircleOperationIntent, operation: PreparedCircleOperation, ) -> Self

A freshly prepared operation, with nothing uploaded yet.

pub fn circle_id(&self) -> CircleId

pub fn operation(&self) -> &PreparedCircleOperation

pub fn operation_mut(&mut self) -> &mut PreparedCircleOperation

pub fn validate_uploaded(&self) -> Result<(), CircleJournalError>

Refuse an upload step that names no object in this operation. Every completed step must name one, so a joined upload row that does not is a journal that contradicts itself.

pub fn candidate_owned_objects( &self, ) -> Result<BTreeSet<ExactObjectRef>, CircleJournalError>

The objects of this operation that remote_objects holds a record for: its commit’s candidate-exclusive graph, plus the commit and the Store head published with it.

The rest of an operation’s objects — its control head, roster and metadata — are shared Circle objects the candidate does not own exclusively, so completing their upload step has no candidate record to mark. This names that set so a caller dispatches on it rather than discovering it by a lookup that comes back empty.

pub fn closed_remote_objects( &self, prepared_objects: &BTreeMap<String, PreparedExactObject>, ) -> Result<Vec<ClosedRemoteObject>, CircleJournalError>

The candidate graph this operation would activate, closed over the stored bytes of its objects.

The bytes come from the caller because this value holds only references to them: the durable copy is in the payload spool, and the caller that has just written or read it supplies what it read.

pub fn state(&self) -> CircleOperationState

pub fn begin_discard(&mut self) -> Result<(), CircleJournalError>

Enter cleanup after a verified nonactivation proof was accepted. Legal from any state whose candidate has not activated — a ready or blocked initial candidate, or a finalization candidate. A candidate that already won its slot has no journal row in these states, so no path reaches here.

pub fn is_discarding(&self) -> bool

pub fn block( &mut self, block: CircleOperationBlock, ) -> Result<(), CircleJournalError>

pub fn unblock(&mut self) -> Result<(), CircleJournalError>

Return a blocked operation to the phase captured when it blocked, so it re-enters the idempotent publish pipeline against its exact retained operation.

pub fn wait_for_close_responses(&mut self) -> Result<(), CircleJournalError>

pub fn begin_finalization( &mut self, operation: PreparedCircleOperation, ) -> Result<(), CircleJournalError>

Install the freshly prepared finalization operation, replacing the one that reached its close.

This is the one point in an operation’s life where the prepared operation changes: the finalization commit is a new candidate graph. Its steps are named for the object kinds they carry, so they repeat the names the superseded operation used — which is why the completed uploads go with the operation they belonged to.

pub fn is_finalizing(&self) -> bool

pub fn is_publishable(&self) -> bool

pub fn commit(&self) -> Result<StoreBatchCommit, CircleJournalError>

pub fn validate_identity(&self) -> Result<(), CircleJournalError>

pub fn kind(&self) -> CircleOperationKind

Trait Implementations

impl Clone for CircleOperationJournal

fn clone(&self) -> CircleOperationJournal

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CircleOperationJournal

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CircleOperationJournal

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CircleOperationJournal

fn eq(&self, other: &CircleOperationJournal) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for CircleOperationJournal

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for CircleOperationJournal

impl StructuralPartialEq for CircleOperationJournal