Struct zenoh_flow_nodes::prelude::LinkMessage

pub struct LinkMessage { /* private fields */ }

A message send on a Zenoh-Flow link: a Payload and a Timestamp.

Implementations

impl LinkMessage

pub fn new(payload: Payload, timestamp: Timestamp) -> Self

pub fn new_serialized(data: Vec<u8>, timestamp: Timestamp) -> Self

Creates a new message from serialised data.

This is used when the message is coming from Zenoh or from a non-rust node.

pub fn get_timestamp(&self) -> &Timestamp

Return the Timestamp associated with this message.

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

Serialises the LinkMessage using bincode into the given buffer.

The inner_buffer is used to serialise (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 stabilises no (re)allocation is performed.

Errors

An error variant is returned in case of:

• fails to serialise

Methods from Deref<Target = Payload>

pub fn try_as_bytes_into(&self, buffer: &mut Vec<u8>) -> Result<()>

Populate buffer with the bytes representation of the Payload.

Performance

This method will serialise the Payload if it is Typed. Otherwise, the bytes representation is simply cloned.

The provided buffer is reused and cleared between calls, so once its capacity stabilises no more allocation is performed.

pub fn try_as_bytes(&self) -> Result<Arc<Vec<u8>>>

Return an Arc containing the bytes representation of the Payload.

Performance

This method will only serialise (and thus allocate) the Payload if it is typed. Otherwise the Arc is cloned.

Trait Implementations

impl Clone for LinkMessage

fn clone(&self) -> LinkMessage

Returns a copy 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 Deref for LinkMessage

type Target = Payload

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

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 From<LinkMessage> for Payload

fn from(data_message: LinkMessage) -> Self

Converts to this type from the input type.

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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for LinkMessage

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

This method tests for self and other values to be equal, and is used by ==.

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

This method 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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method 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