Struct OutgoingMessage 

pub struct OutgoingMessage { /* private fields */ }

A message to be sent to the peer.

OutgoingMessages are generated when the protocol requires data to be sent to the peer. Unless the connection is terminated, they should not be dropped, but can be sent in any order.

A message that spans one or more frames must have its internal frame order preserved. In general, the OutgoingMessage::frames() iterator should be used, even for single-frame messages.

Implementations

impl OutgoingMessage

pub const fn is_multi_frame(&self, max_frame_size: MaxFrameSize) -> bool

Returns whether or not a message will span multiple frames.

pub const fn frames(self) -> FrameIter

Creates an iterator over all frames in the message.

pub fn frame_iter( self, max_frame_size: MaxFrameSize, ) -> impl Iterator<Item = OutgoingFrame>

Creates an iterator over all frames in the message with a fixed maximum frame size.

A slightly more convenient frames method, with a fixed max_frame_size. The resulting iterator will use slightly more memory than the equivalent FrameIter.

pub const fn header(&self) -> Header

Returns the outgoing message’s header.

pub const fn non_header_len(&self) -> usize

Calculates the total number of bytes that are not header data that will be transmitted with this message (the payload + its variable length encoded length prefix).

pub const fn num_frames(&self, max_frame_size: MaxFrameSize) -> usize

Calculates the number of frames this message will produce.

pub const fn total_len(&self, max_frame_size: MaxFrameSize) -> usize

Calculates the total length in bytes of all frames produced by this message.

pub fn iter_bytes(self, max_frame_size: MaxFrameSize) -> ByteIter

Creates an byte-iterator over all frames in the message.

The returned ByteIter will return all frames in sequence using the bytes::Buf trait, with no regard for frame boundaries, thus it is only suitable to send all frames of the message with no interleaved data.

pub fn to_bytes(self, max_frame_size: MaxFrameSize) -> Bytes

Writes out all frames as they should be sent out on the wire into a Bytes struct.

Consider using the frames() or bytes() methods instead to avoid additional copies. This method is not zero-copy, but still consumes self to avoid a conversion of a potentially unshared payload buffer.

pub fn truncate_to_single_frame(&mut self, max_frame_size: MaxFrameSize)

Truncates the message payload so that it fits into the first frame.

Trait Implementations

impl Clone for OutgoingMessage

fn clone(&self) -> OutgoingMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OutgoingMessage

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

Formats the value using the given formatter.

impl PartialEq for OutgoingMessage

fn eq(&self, other: &OutgoingMessage) -> 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 Eq for OutgoingMessage

impl StructuralPartialEq for OutgoingMessage