Struct Tombstone 

pub struct Tombstone {
    pub actor: Vec<u8>,
    pub timestamp_millis: u64,
    pub causal_metadata: BTreeMap<String, Vec<u8>>,
}

Logical deletion value with causal metadata.

The actor identifies who or what performed the delete. The timestamp is a caller-provided Unix millisecond value. Causal metadata is sorted by key when encoded, making the byte representation deterministic.

Fields

actor: Vec<u8>

Actor that created the tombstone.

timestamp_millis: u64

Unix timestamp in milliseconds supplied by the caller.

causal_metadata: BTreeMap<String, Vec<u8>>

Application-defined causal metadata.

Implementations

impl Tombstone

pub fn new(actor: impl Into<Vec<u8>>, timestamp_millis: u64) -> Self

Create a tombstone with no causal metadata.

pub fn with_causal_metadata( self, key: impl Into<String>, value: impl Into<Vec<u8>>, ) -> Self

Add causal metadata and return the tombstone for chaining.

pub fn insert_causal_metadata( &mut self, key: impl Into<String>, value: impl Into<Vec<u8>>, ) -> &mut Self

Insert or replace one causal metadata entry.

pub fn causal_metadata(&self, key: &str) -> Option<&[u8]>

Borrow one causal metadata value.

pub fn to_bytes(&self) -> Result<Vec<u8>, Error>

Encode this tombstone as deterministic bytes suitable for a leaf value.

pub fn from_bytes(bytes: &[u8]) -> Result<Self, Error>

Decode a tombstone envelope.

pub fn from_stored_bytes(bytes: &[u8]) -> Result<Option<Self>, Error>

Decode stored bytes, returning Ok(None) for non-tombstone values.

Values that start with the tombstone magic but contain an invalid tombstone envelope return an error.

pub fn is_encoded(bytes: &[u8]) -> bool

Return true if bytes start with the tombstone magic prefix.

pub fn to_upsert_mutation( &self, key: impl Into<Vec<u8>>, ) -> Result<Mutation, Error>

Build an upsert mutation that stores this tombstone at key.

Trait Implementations

impl Clone for Tombstone

fn clone(&self) -> Tombstone

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Tombstone

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Tombstone

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Tombstone

impl PartialEq for Tombstone

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Tombstone

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 Tombstone