Struct ZmqMessage 

pub struct ZmqMessage { /* private fields */ }

A multi-frame ZMQ message.

Construct from a single frame via From<Bytes>, From<Vec<u8>>, From<String>, or From<&str>. For multi-frame messages use push_back or TryFrom<Vec<Bytes>>.

Examples

use rustzmq2::ZmqMessage;
use bytes::Bytes;

// Single-frame from any byte-ish input.
let m1: ZmqMessage = "hello".into();
assert_eq!(m1.first().map(|b| b.as_ref()), Some(&b"hello"[..]));

// Multi-frame envelope: prepend a header onto a body.
let mut m2 = ZmqMessage::from(b"body".to_vec());
m2.push_front(b"header".to_vec());
assert_eq!(m2.len(), 2);

// Build from any iterator of byte-ish values.
let m3: ZmqMessage = ["a", "b", "c"].into_iter().collect();
assert_eq!(m3.len(), 3);

// Reject empty up front.
let m4 = ZmqMessage::try_from(vec![Bytes::from_static(b"x"), Bytes::from_static(b"y")]).unwrap();
assert_eq!(m4.last().map(|b| b.as_ref()), Some(&b"y"[..]));

Implementations

impl ZmqMessage

pub fn push_back(&mut self, frame: impl Into<Bytes>)

Append a frame to the end of the message.

Accepts anything that converts into Bytes — Vec<u8>, &[u8], &'static [u8], String, &str, or a Bytes directly.

pub fn push_front(&mut self, frame: impl Into<Bytes>)

Prepend a frame at the front of the message.

Accepts anything that converts into Bytes.

pub fn iter(&self) -> Iter<'_, Bytes>

Iterate over frames in order.

pub fn iter_mut(&mut self) -> IterMut<'_, Bytes>

Iterate over frames in order, allowing mutation. Replacing a frame is cheap; in-place editing of Bytes is not (it’s an immutable reference-counted slice — call *frame = new_bytes; to swap).

pub fn first(&self) -> Option<&Bytes>

First frame, or None if the message is empty.

pub fn last(&self) -> Option<&Bytes>

Last frame, or None if the message is empty.

pub fn first_mut(&mut self) -> Option<&mut Bytes>

Mutable reference to the first frame, or None if the message is empty.

pub fn last_mut(&mut self) -> Option<&mut Bytes>

Mutable reference to the last frame, or None if the message is empty.

pub fn pop_front(&mut self) -> Option<Bytes>

Remove and return the first frame, or None if the message is empty. Useful for peeling envelope prefixes (e.g. ROUTER identity frames).

pub fn pop_back(&mut self) -> Option<Bytes>

Remove and return the last frame, or None if the message is empty.

pub fn len(&self) -> usize

Number of frames in the message.

pub fn is_empty(&self) -> bool

Returns true if the message contains no frames.

pub fn get(&self, index: usize) -> Option<&Bytes>

Returns a reference to the frame at index, or None if out of bounds.

pub fn into_vec(self) -> Vec<Bytes>

Consume the message and return its frames as a Vec<Bytes>.

pub fn into_vecdeque(self) -> VecDeque<Bytes>

Consume the message and return its frames as a VecDeque<Bytes>.

pub fn prepend(&mut self, message: &ZmqMessage)

Prepend all frames of message to the front of self, in order.

pub fn split_off(&mut self, at: usize) -> ZmqMessage

Split the message at at, returning a new message containing frames [at..] while self retains [..at].

Trait Implementations

impl Clone for ZmqMessage

fn clone(&self) -> ZmqMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ZmqMessage

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

Formats the value using the given formatter.

impl Default for ZmqMessage

fn default() -> ZmqMessage

Returns the “default value” for a type.

impl<B: Into<Bytes>> Extend<B> for ZmqMessage

fn extend<I: IntoIterator<Item = B>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl From<&[u8]> for ZmqMessage

fn from(b: &[u8]) -> Self

Converts to this type from the input type.

impl From<&str> for ZmqMessage

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<Bytes> for ZmqMessage

fn from(b: Bytes) -> Self

Converts to this type from the input type.

impl From<String> for ZmqMessage

fn from(s: String) -> Self

Converts to this type from the input type.

impl From<Vec<u8>> for ZmqMessage

fn from(v: Vec<u8>) -> Self

Converts to this type from the input type.

impl<B: Into<Bytes>> FromIterator<B> for ZmqMessage

fn from_iter<I: IntoIterator<Item = B>>(iter: I) -> Self

Collect frames into a ZmqMessage. The resulting message may be empty if the iterator yielded nothing — most send paths reject empty messages, so prefer TryFrom<Vec<Bytes>> when you want the emptiness check up front.

impl Hash for ZmqMessage

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Index<usize> for ZmqMessage

fn index(&self, index: usize) -> &Self::Output

Indexed access to a frame. Panics on out-of-bounds; use get for the checked variant.

type Output = Bytes

The returned type after indexing.

impl<'a> IntoIterator for &'a ZmqMessage

type Item = &'a Bytes

The type of the elements being iterated over.

type IntoIter = Iter<'a, Bytes>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for &'a mut ZmqMessage

type Item = &'a mut Bytes

The type of the elements being iterated over.

type IntoIter = IterMut<'a, Bytes>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl IntoIterator for ZmqMessage

type Item = Bytes

The type of the elements being iterated over.

type IntoIter = IntoIter<[Bytes; 2]>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for ZmqMessage

fn eq(&self, other: &ZmqMessage) -> 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 TryFrom<Vec<Bytes>> for ZmqMessage

type Error = ZmqEmptyMessageError

The type returned in the event of a conversion error.

fn try_from(v: Vec<Bytes>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<VecDeque<Bytes>> for ZmqMessage

type Error = ZmqEmptyMessageError

The type returned in the event of a conversion error.

fn try_from(v: VecDeque<Bytes>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<ZmqMessage> for Bytes

type Error = MessageConversionError

The type returned in the event of a conversion error.

fn try_from(z: ZmqMessage) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<ZmqMessage> for String

type Error = MessageConversionError

The type returned in the event of a conversion error.

fn try_from(z: ZmqMessage) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<ZmqMessage> for Vec<u8>

type Error = MessageConversionError

The type returned in the event of a conversion error.

fn try_from(z: ZmqMessage) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for ZmqMessage

impl StructuralPartialEq for ZmqMessage