Struct CausalContext 

pub struct CausalContext {
    pub parent_id: Option<MessageId>,
    pub vector_clock_entry: Option<u64>,
}

Causal metadata carried inside a protocol message envelope.

Fields

parent_id: Option<MessageId>

Optional reference to the causally preceding message.

vector_clock_entry: Option<u64>

Optional logical timestamp for this message’s causal-chain position.

Implementations

impl CausalContext

pub const fn independent() -> Self

Create a causally independent context with no parent or vector-clock entry.

pub const fn with_parent(parent_id: MessageId) -> Self

Create a context that follows parent_id in a causal chain.

pub fn encoded_len(&self) -> Result<usize, ProtocolError>

Return the number of bytes needed for deterministic causal-context encoding.

Errors

Returns ProtocolError::CodecError when the message id length cannot fit in the protocol’s u32 length field or the total length overflows usize.

pub fn serialize(&self) -> Result<Vec<u8>, ProtocolError>

Serialize this causal context with deterministic big-endian field encoding.

Errors

Returns ProtocolError::CodecError when a length field cannot represent the encoded context.

pub fn to_wire_bytes(&self) -> Result<Vec<u8>, ProtocolError>

Serialize this causal context for wire transport.

Errors

Returns ProtocolError::CodecError when a length field cannot represent the encoded context.

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

Deserialize a causal context from deterministic wire bytes.

Errors

Returns ProtocolError::CodecError when the bytes are truncated, contain invalid presence tags, contain invalid UTF-8 message ids, or contain trailing bytes.

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

Deserialize a causal context from deterministic wire bytes.

Errors

Returns ProtocolError::CodecError when the bytes are truncated, contain invalid presence tags, contain invalid UTF-8 message ids, or contain trailing bytes.

Trait Implementations

impl Clone for CausalContext

fn clone(&self) -> CausalContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CausalContext

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

Formats the value using the given formatter.

impl Default for CausalContext

fn default() -> Self

Returns the “default value” for a type.

impl Eq for CausalContext

impl PartialEq for CausalContext

fn eq(&self, other: &CausalContext) -> 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 StructuralPartialEq for CausalContext