Struct PushPullMessage

pub struct PushPullMessage<I> {
    pub ltime: LamportTime,
    pub status_ltimes: IndexMap<I, LamportTime>,
    pub left_members: IndexSet<I>,
    pub event_ltime: LamportTime,
    pub events: TinyVec<Option<UserEvents>>,
    pub query_ltime: LamportTime,
}

Used when doing a state exchange. This is a relatively large message, but is sent infrequently

Fields

ltime: LamportTime

Current node lamport time

status_ltimes: IndexMap<I, LamportTime>

Maps the node to its status time

left_members: IndexSet<I>

List of left nodes

event_ltime: LamportTime

Lamport time for event clock

events: TinyVec<Option<UserEvents>>

Recent events

query_ltime: LamportTime

Lamport time for query clock

Implementations

impl<I> PushPullMessage<I>

pub const fn ltime(&self) -> LamportTime

Returns the lamport time

pub const fn status_ltimes(&self) -> &IndexMap<I, LamportTime>

Returns the maps the node to its status time

pub const fn left_members(&self) -> &IndexSet<I>

Returns the list of left nodes

pub const fn event_ltime(&self) -> LamportTime

Returns the lamport time for event clock

pub const fn events(&self) -> &TinyVec<Option<UserEvents>>

Returns the recent events

pub const fn query_ltime(&self) -> LamportTime

Returns the lamport time for query clock

pub const fn with_ltime(self, val: LamportTime) -> Self

Sets the lamport time (Builder pattern)

pub fn with_status_ltimes(self, val: IndexMap<I, LamportTime>) -> Self

Sets the maps the node to its status time (Builder pattern)

pub fn with_left_members(self, val: IndexSet<I>) -> Self

Sets the list of left nodes (Builder pattern)

pub const fn with_event_ltime(self, val: LamportTime) -> Self

Sets the lamport time for event clock (Builder pattern)

pub fn with_events(self, val: TinyVec<Option<UserEvents>>) -> Self

Sets the recent events (Builder pattern)

pub const fn with_query_ltime(self, val: LamportTime) -> Self

Sets the lamport time for query clock (Builder pattern)

Trait Implementations

impl<I, A> AsMessageRef<I, A> for &PushPullMessage<I>

fn as_message_ref(&self) -> SerfMessageRef<'_, I, A>

Converts this type into a shared reference of the (usually inferred) input type.

impl<I: Clone> Clone for PushPullMessage<I>

fn clone(&self) -> PushPullMessage<I>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<I: Debug> Debug for PushPullMessage<I>

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

Formats the value using the given formatter.

impl<'de, I> Deserialize<'de> for PushPullMessage<I>

where I: Eq + Hash + Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a, I> From<&'a PushPullMessage<I>> for PushPullMessageRef<'a, I>

fn from(msg: &'a PushPullMessage<I>) -> Self

Converts to this type from the input type.

impl<'a, I> From<&'a mut PushPullMessage<I>> for PushPullMessageRef<'a, I>

fn from(msg: &'a mut PushPullMessage<I>) -> Self

Converts to this type from the input type.

impl<I> PartialEq for PushPullMessage<I>

where I: Hash + Eq,

fn eq(&self, other: &Self) -> 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<I> Serialize for PushPullMessage<I>

where I: Eq + Hash + Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<I> Transformable for PushPullMessage<I>

where I: Transformable + Hash + Eq,

type Error = PushPullMessageTransformError<I>

The error type returned when encoding or decoding fails.

fn encode(&self, dst: &mut [u8]) -> Result<usize, Self::Error>

Encodes the value into the given buffer for transmission.

fn encoded_len(&self) -> usize

Returns the encoded length of the value. This is used to pre-allocate a buffer for encoding.

fn decode(src: &[u8]) -> Result<(usize, Self), Self::Error>

where Self: Sized,

Decodes the value from the given buffer received over the wire.

fn encode_to_vec(&self) -> Result<Vec<u8>, Self::Error>

Encodes the value into a vec for transmission.

fn encode_to_writer<W>(&self, writer: &mut W) -> Result<usize, Error>

where W: Write,

Encodes the value into the given writer for transmission.

fn encode_to_async_writer<W>( &self, writer: &mut W, ) -> impl Future<Output = Result<usize, Error>> + Send

where W: AsyncWrite + Send + Unpin,

Encodes the value into the given async writer for transmission.

fn decode_from_reader<R>(reader: &mut R) -> Result<(usize, Self), Error>

where R: Read, Self: Sized,

Decodes the value from the given reader received over the wire.

fn decode_from_async_reader<R>( reader: &mut R, ) -> impl Future<Output = Result<(usize, Self), Error>> + Send

where R: AsyncRead + Send + Unpin, Self: Sized,

Decodes the value from the given async reader received over the wire.