Struct UserEventMessage

pub struct UserEventMessage {
    pub ltime: LamportTime,
    pub name: SmolStr,
    pub payload: Bytes,
    pub cc: bool,
}

Used for user-generated events

Fields

ltime: LamportTime

The lamport time

name: SmolStr

The name of the event

payload: Bytes

The payload of the event

cc: bool

“Can Coalesce”.

Implementations

impl UserEventMessage

pub const fn ltime(&self) -> LamportTime

Returns the lamport time for this message

pub const fn name(&self) -> &SmolStr

Returns the name of the event

pub const fn payload(&self) -> &Bytes

Returns the payload of the event

pub const fn cc(&self) -> bool

Returns if this message can be coalesced

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

Sets the lamport time for this message (Builder pattern)

pub fn with_name(self, val: SmolStr) -> Self

Sets the name of the event (Builder pattern)

pub fn with_payload(self, val: Bytes) -> Self

Sets the payload of the event (Builder pattern)

pub const fn with_cc(self, val: bool) -> Self

Sets if this message can be coalesced (Builder pattern)

Trait Implementations

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

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

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

impl<I, A> AsMessageRef<I, A> for UserEventMessage

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

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

impl CheapClone for UserEventMessage

fn cheap_clone(&self) -> Self

Returns a copy of the value.

impl Clone for UserEventMessage

fn clone(&self) -> UserEventMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UserEventMessage

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

Formats the value using the given formatter.

impl Default for UserEventMessage

fn default() -> UserEventMessage

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for UserEventMessage

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for UserEventMessage

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Transformable for UserEventMessage

type Error = UserEventMessageTransformError

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.

impl Eq for UserEventMessage

impl StructuralPartialEq for UserEventMessage