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)>,
    },
}

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.

Fields

collection: String

edges: SortedVec<(u32, u32)>

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) -> EngineKeySet

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: &EngineKeySet) -> 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 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.