Skip to main content

CausalContext

Struct CausalContext 

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

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§

Source§

impl CausalContext

Source

pub const fn independent() -> Self

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

Source

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

Create a context that follows parent_id in a causal chain.

Source

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.

Source

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.

Source

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.

Source

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.

Source

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§

Source§

impl Clone for CausalContext

Source§

fn clone(&self) -> Self

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 CausalContext

Source§

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

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

impl Default for CausalContext

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for CausalContext

Source§

impl PartialEq for CausalContext

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for CausalContext

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<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> 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 = !

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

fn try_from(value: U) -> Result<T, !>

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.