Struct Message 

pub struct Message<D: MessageData = Vec<u8>> {
    pub data: D,
    pub address: Option<SocketAddress>,
    pub credentials: Option<ucred>,
    pub ancillary_data: Vec<AncillaryData>,
}

A Message represents a typed segment of bytes within a MessageQueue.

Fields

data: D

The data contained in the message.

address: Option<SocketAddress>

The address from which the message was sent.

credentials: Option<ucred>

The Unix credentials associated with the message.

ancillary_data: Vec<AncillaryData>

The ancillary data that is associated with this message.

Implementations

impl<D: MessageData> Message<D>

pub fn new( data: D, address: Option<SocketAddress>, credentials: Option<ucred>, ancillary_data: Vec<AncillaryData>, ) -> Self

Creates a a new message with the provided message and ancillary data.

pub fn len(&self) -> usize

Returns the length of the message in bytes.

Note that ancillary data does not contribute to the length of the message.

pub fn clone_at_most(&self, limit: usize) -> Self

pub fn truncate(&mut self, limit: usize)

Shortens the message data, keeping the first limit elements and dropping the rest.

If limit is greater or equal to the current data length, this has no effect.

pub fn split_off(&mut self, index: usize) -> Option<Self>

Splits the message at index, returning the remaining message if index < self.len().

The message’s address and credentials metadata are preserved on the remaining message, while one-shot ancillary data such as SCM_RIGHTS is only kept on self.

Trait Implementations

impl<D: Clone + MessageData> Clone for Message<D>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<D: Debug + MessageData> Debug for Message<D>

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

Formats the value using the given formatter.

impl<D: MessageData> From<D> for Message<D>

fn from(data: D) -> Self

Converts to this type from the input type.