Struct rustix::net::RecvAncillaryBuffer

pub struct RecvAncillaryBuffer<'buf> {
    buffer: &'buf mut [u8],
    read: usize,
    length: usize,
}

Buffer for receiving ancillary messages with recvmsg.

Use the drain function to iterate over the received messages.

Fields

buffer: &'buf mut [u8]

Raw byte buffer for messages.

read: usize

The portion of the buffer we’ve read from already.

length: usize

The amount of the buffer that is used.

Implementations

impl<'buf> RecvAncillaryBuffer<'buf>

pub fn new(buffer: &'buf mut [u8]) -> Self

Create a new, empty RecvAncillaryBuffer from a raw byte buffer.

The buffer size may be computed with cmsg_space, or it may be zero for an empty buffer, however in that case, consider default() instead, or even using recv instead of recvmsg.

Examples

Allocate a buffer for a single file descriptor:

let mut space = [0; rustix::cmsg_space!(ScmRights(1))];
let mut cmsg_buffer = RecvAncillaryBuffer::new(&mut space);

Allocate a buffer for credentials:

let mut space = [0; rustix::cmsg_space!(ScmCredentials(1))];
let mut cmsg_buffer = RecvAncillaryBuffer::new(&mut space);

Allocate a buffer for two file descriptors and credentials:

let mut space = [0; rustix::cmsg_space!(ScmRights(2), ScmCredentials(1))];
let mut cmsg_buffer = RecvAncillaryBuffer::new(&mut space);

pub(crate) fn as_control_ptr(&mut self) -> *mut u8

Returns a pointer to the message data.

pub(crate) fn control_len(&self) -> usize

Returns the length of the message data.

pub(crate) unsafe fn set_control_len(&mut self, len: usize)

Set the length of the message data.

Safety

The buffer must be filled with valid message data.

pub(crate) fn clear(&mut self)

Delete all messages from the buffer.

pub fn drain(&mut self) -> AncillaryDrain<'_>

Drain all messages from the buffer.

Trait Implementations

impl<'buf> Default for RecvAncillaryBuffer<'buf>

fn default() -> RecvAncillaryBuffer<'buf>

Returns the “default value” for a type.

impl Drop for RecvAncillaryBuffer<'_>

fn drop(&mut self)

Executes the destructor for this type.

impl<'buf> From<&'buf mut [u8]> for RecvAncillaryBuffer<'buf>

fn from(buffer: &'buf mut [u8]) -> Self

Converts to this type from the input type.