Enum EngineKeySet 

pub enum EngineKeySet {
    Document {
        collection: String,
        surrogates: SortedVec<u32>,
    },
    Vector {
        collection: String,
        surrogates: SortedVec<u32>,
    },
    Kv {
        collection: String,
        keys: SortedVec<Vec<u8>>,
    },
    Edge {
        collection: String,
        edges: SortedVec<(u32, u32)>,
        home_vshards: SortedVec<u32>,
    },
    Array {
        collection: String,
        vshards: SortedVec<u32>,
    },
    Collection {
        collection: String,
        vshards: SortedVec<u32>,
    },
    Unique {
        collection: String,
        index: String,
        values: SortedVec<Vec<u8>>,
    },
}

A typed key set for one engine within a read or write set.

Keys are normalized to surrogates (or byte keys for KV) at admission, so all engine-specific naming is resolved upstream of the sequencer.

Variants

Document

Document engine (schemaless or strict): identified by surrogate.

Fields

collection: String

surrogates: SortedVec<u32>

Vector

Vector engine: identified by surrogate.

Fields

collection: String

surrogates: SortedVec<u32>

Kv

Key-Value engine: identified by raw byte keys.

Fields

collection: String

keys: SortedVec<Vec<u8>>

Edge

Graph edge engine: identified by (src_surrogate, dst_surrogate) pairs.

edges carries the surrogate-pair IDENTITY used for Calvin locking and conflict detection. home_vshards carries the from_key ROUTING homes — the set of VShardId::from_key(src_str) / from_key(dst_str) u32 ids for every edge in this set. Routing (which vShards participate) is driven by home_vshards, NOT by the collection name, because a graph edge is dual-homed across its two endpoint key-hashed vShards.

Fields

collection: String

edges: SortedVec<(u32, u32)>

home_vshards: SortedVec<u32>

Array

Array engine: the array’s cells on each vShard in vshards.

An array is tile-partitioned: its cells live on the vShards their tiles hash to, not on the array’s collection home. Each vShard in vshards participates, and the transaction locks the whole array on it. Appended last: the encoding is positional.

Fields

collection: String

vshards: SortedVec<u32>

Collection

A whole collection on each vShard in vshards, or on the collection’s own vShard when vshards is empty.

In a write set the transaction locks the collection exclusively: a truncate, bulk, predicate, or identity-less write. In a read set it locks the collection shared: a predicate, scan, or index read. A read that observed the collection on named vShards, such as a cross-shard graph read, names them in vshards.

Fields

collection: String

vshards: SortedVec<u32>

Unique

UNIQUE values a write claims in one index of collection.

Each value is the canonical index value the Data Plane judges. Two transactions that claim one value lock one key, so they serialize.

Fields

collection: String

index: String

values: SortedVec<Vec<u8>>

Implementations

impl EngineKeySet

pub fn serialized_size_hint(&self) -> usize

O(1) estimate of the serialized byte size of this key set.

Used by the dependent-read cap check at sequencer admission to bound the total bytes that would be Raft-replicated in a CalvinReadResult entry. This is an estimate, not an exact count; do NOT use it as a correctness check — only as a pre-flight guard.

pub fn collection(&self) -> &str

The collection this key set belongs to.

pub fn is_empty(&self) -> bool

Returns true if this key set contains no keys.

Trait Implementations

impl Clone for EngineKeySet

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EngineKeySet

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EngineKeySet

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for EngineKeySet

impl<'__msgpack_de> FromMessagePack<'__msgpack_de> for EngineKeySet

fn read<R: Read<'__msgpack_de>>(reader: &mut R) -> Result<Self, Error>

where Self: Sized,

Reads the MessagePack representation of this value from the provided reader.

impl PartialEq for EngineKeySet

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for EngineKeySet

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for EngineKeySet

impl ToMessagePack for EngineKeySet

fn write<W: Write>(&self, writer: &mut W) -> Result<(), Error>

Writes the MessagePack representation of this value into the provided writer.

fn write_slice<W>(values: &[Self], writer: &mut W) -> Result<(), Error>

where W: Write, Self: Sized,

Writes the MessagePack representation of a slice of values into the provided writer.

fn size_hint(&self) -> Option<TrustedSizeHint>

Returns a trusted upper bound for the number of bytes written by the next call to Self::write, or None when it cannot be determined cheaply.

fn max_size() -> Option<TrustedSizeHint>

where Self: Sized,

Returns a trusted upper bound valid for every value of this type.