Struct zmq::Message

pub struct Message { /* fields omitted */ }

Holds a 0MQ message.

A message is a single frame, either received or created locally and then sent over the wire. Multipart messages are transmitted as multiple Messages.

In rust-zmq, you aren't required to create message objects if you use the convenience APIs provided (e.g. Socket::recv_bytes() or Socket::send_str()). However, using message objects can make multiple operations in a loop more efficient, since allocated memory can be reused.

Methods

impl Message

pub fn new() -> Result<Message>

Create an empty Message.

pub unsafe fn with_capacity_unallocated(len: usize) -> Result<Message>

Create a Message preallocated with len uninitialized bytes.

pub fn with_capacity(len: usize) -> Result<Message>

Create a Message with space for len bytes that are initialized to 0.

pub fn from_slice(data: &[u8]) -> Result<Message>

Create a Message from a &[u8]. This will copy data into the message.

pub fn as_str(&self) -> Option<&str>

Return the message content as a string slice if it is valid UTF-8.

pub fn get_more(&self) -> bool

Return the ZMQ_MORE flag, which indicates if more parts of a multipart message will follow.

pub fn gets<'a>(&'a mut self, property: &str) -> Option<&'a str>

Query a message metadata property.

Trait Implementations

impl Drop for Message

fn drop(&mut self)

Executes the destructor for this type.

impl Eq for Message

impl PartialEq<Message> for Message

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Debug for Message

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

Formats the value using the given formatter.

impl Deref for Message

type Target = [u8]

The resulting type after dereferencing.

fn deref(&self) -> &[u8]

Dereferences the value.

impl DerefMut for Message

fn deref_mut(&mut self) -> &mut [u8]

Mutably dereferences the value.