Skip to main content

Operation

Struct Operation 

Source
pub struct Operation {
    pub kind: OperationKind,
    pub parents: Vec<OpId>,
    pub intent_id: Option<IntentId>,
}
Expand description

The operation as a whole — its kind and the causal predecessors it assumes. The OpId is computed from this plus a sorted view of parents.

Operations without parents are valid and represent “applies to the empty repository” or “applies to the synthetic genesis state.” lex store migrate v1→v2 will produce parentless ops for stages it can’t trace back to a clear predecessor.

Fields§

§kind: OperationKind§parents: Vec<OpId>

Operations whose produces this op assumes. Sorted before hashing for canonical form. Empty for ops against the empty repo.

§intent_id: Option<IntentId>

The intent that caused this op, if known. Optional because operations produced outside an agent harness (e.g. a human running lex publish directly) don’t have one.

Including the intent in the canonical hash means the same logical change made under different intents produces different OpIds — causally distinct events should hash distinctly. Ops with intent_id: None keep their existing hashes (the field is omitted from the canonical JSON via skip_serializing_if), so this is backwards-compatible for stores written before #131.

Implementations§

Source§

impl Operation

Source

pub fn new(kind: OperationKind, parents: impl IntoIterator<Item = OpId>) -> Self

Construct an operation against zero or more parents. Caller supplies parents in any order; canonicalization sorts them before hashing.

Source

pub fn with_intent(self, intent_id: impl Into<IntentId>) -> Self

Tag this operation with the intent that produced it. The builder shape keeps existing call sites untouched; agent harnesses that record intent call this once before applying the op.

Source

pub fn op_id(&self) -> OpId

Compute this operation’s content-addressed identity under the current production canonical form (OperationFormat::CURRENT).

Stable across runs and machines: same (kind, payload, sorted parents, intent_id) produces the same OpId. The invariant #129’s automatic-dedup behavior relies on.

Source

pub fn op_id_in(&self, format: OperationFormat) -> OpId

Compute the OpId under a specific canonical-form version.

Used by crate::migrate to derive new OpIds when porting a store across format versions. Production code should call Self::op_id.

Source

pub fn canonical_bytes(&self) -> Vec<u8>

The byte sequence that gets hashed to produce Self::op_id under the current canonical form. Equivalent to self.canonical_bytes_in(OperationFormat::CURRENT).

Exposed (not just consumed by op_id) so golden tests can pin the exact pre-image. Not equal to serde_json::to_vec(&op) in general — the on-disk JSON skips empty parents and None intent_id, while the canonical form always emits a (sorted, deduped) parents array. See canonical.rs for the full V1 canonical-form spec.

Source

pub fn canonical_bytes_in(&self, format: OperationFormat) -> Vec<u8>

The pre-image hashed under a specific canonical-form version.

Today every OperationFormat variant routes to V1’s encoder (only V1 exists in production). When V2 lands, this match gains an arm and the migration tool’s encoder closure routes here.

Trait Implementations§

Source§

impl Clone for Operation

Source§

fn clone(&self) -> Operation

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Operation

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for Operation

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for Operation

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl Serialize for Operation

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl Eq for Operation

Source§

impl StructuralPartialEq for Operation

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,