Enum LinkMessage 

pub enum LinkMessage {
    Data(DataMessage),
    Watermark(Timestamp),
}

The Zenoh-Flow message that is sent across Link and across Zenoh.

It contains either a DataMessage or a Timestamp, in such case the LinkMessage variant is Watermark.

Variants

Data(DataMessage)

Watermark(Timestamp)

Implementations

impl LinkMessage

pub fn from_payload(output: Payload, timestamp: Timestamp) -> Self

Creates a LinkMessage::Data from a Payload.

pub fn serialize_bincode_into( &self, message_buffer: &mut Vec<u8>, payload_buffer: &mut Vec<u8>, ) -> Result<()>

Serializes the LinkMessage using bincode into the given buffer.

The inner_buffer is used to serialize (if need be) the Payload contained inside the LinkMessage.

Performance

The provided buffer and inner_buffer are reused and cleared between calls, so once their capacity stabilizes no (re)allocation is performed.

Errors

An error variant is returned in case of:

• fails to serialize

pub fn serialize_bincode_into_shm( &self, shm_buffer: &mut [u8], payload_buffer: &mut Vec<u8>, ) -> Result<()>

Serializes the LinkMessage using bincode into the given shm_buffer shared memory buffer.

The inner_buffer is used to serialize (if need be) the Payload contained inside the LinkMessage.

Performance

The provided inner_buffer is reused and cleared between calls, so once its capacity stabilizes no (re)allocation is performed.

Errors

An error variant is returned in case of:

• fails to serialize
• there is not enough space in the slice

pub fn get_timestamp(&self) -> Timestamp

Returns the Timestamp associated with the message.

Trait Implementations

impl Clone for LinkMessage

fn clone(&self) -> LinkMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LinkMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for LinkMessage

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Ord for LinkMessage

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for LinkMessage

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 PartialOrd for LinkMessage

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for LinkMessage

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for LinkMessage