Struct wire_framed_core::Message

pub struct Message { /* private fields */ }

A message with frames.

Frame

A frame consists of the length of the blob and the blob itself.

| blob length | blob |

Message

A message consists of (potentially) many frames. After a frame, a special byte exists to denote if the message has more frames to read. The byte contains 0 if it has no more frames and 1 if it has.

| frame | frame end byte |

Implementations

impl Message

pub fn new() -> Self

Construct an empty Message.

pub fn from_frames(frames: impl Into<VecDeque<Bytes>>) -> Self

Constructs a Message from an iterator of [Frame]s.

pub fn builder() -> MessageBuilder

Constructs a MessageBuilder.

pub fn push(&mut self, frame: Bytes)

Push a frame into the message.

pub fn extend(&mut self, frames: impl IntoIterator<Item = Bytes>)

Extends a collection with the contents of an iterator.

pub fn push_message(&mut self, msg: Message)

Push a message into the message.

pub fn prepend(&mut self, frame: Bytes)

Prepend a frame into the message.

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

Pop a frame off the message.

pub fn frame_count(&self) -> usize

Returns the number of frames in the message.

pub fn byte_count(&self) -> usize

Returns the total length of the message in bytes.

pub fn as_deque(&self) -> &VecDeque<Bytes>

Returns the message as an immutable VecDeque of frames.

pub fn as_deque_mut(&mut self) -> &mut VecDeque<Bytes>

Returns the message as a mutable VecDeque of frames.

Trait Implementations

impl Clone for Message

fn clone(&self) -> Message

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Message

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

Formats the value using the given formatter.

impl Default for Message

fn default() -> Self

Returns the “default value” for a type.

impl Encoder<Message> for MessageCodec

type Error = Error

The type of encoding errors.

fn encode( &mut self, item: Message, dst: &mut BytesMut ) -> Result<(), Self::Error>

Encodes a frame into the buffer provided.

impl IntoMessage for Message

fn extend_message(&self, msg: &mut Message)

Extend a Message with the contents of Self.

fn into_message(&self) -> Message

Converts Self into an owned Message.

fn into_bytes(&self) -> Bytes

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 ==.

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 Eq for Message

impl StructuralEq for Message

impl StructuralPartialEq for Message