Struct socket2::MsgHdrMut

pub struct MsgHdrMut<'addr, 'bufs, 'control> {
    pub(crate) inner: msghdr,
    pub(crate) _lifetimes: PhantomData<(&'addr mut SockAddr, &'bufs mut MaybeUninitSlice<'bufs>, &'control mut [u8])>,
}

Configuration of a recvmsg(2) system call.

This wraps msghdr on Unix and WSAMSG on Windows. Also see MsgHdr for the variant used by sendmsg(2).

Fields

inner: msghdr

_lifetimes: PhantomData<(&'addr mut SockAddr, &'bufs mut MaybeUninitSlice<'bufs>, &'control mut [u8])>

Implementations

impl<'addr, 'bufs, 'control> MsgHdrMut<'addr, 'bufs, 'control>

pub fn new() -> MsgHdrMut<'addr, 'bufs, 'control>

Create a new MsgHdrMut with all empty/zero fields.

pub fn with_addr(self, addr: &'addr mut SockAddr) -> Self

Set the mutable address (name) of the message.

Corresponds to setting msg_name and msg_namelen on Unix and name and namelen on Windows.

pub fn with_buffers(self, bufs: &'bufs mut [MaybeUninitSlice<'_>]) -> Self

Set the mutable buffer(s) of the message.

Corresponds to setting msg_iov and msg_iovlen on Unix and lpBuffers and dwBufferCount on Windows.

pub fn with_control(self, buf: &'control mut [MaybeUninit<u8>]) -> Self

Set the mutable control buffer of the message.

Corresponds to setting msg_control and msg_controllen on Unix and Control on Windows.

pub fn flags(&self) -> RecvFlags

Returns the flags of the message.

pub fn control_len(&self) -> usize

Gets the length of the control buffer.

Can be used to determine how much, if any, of the control buffer was filled by recvmsg.

Corresponds to msg_controllen on Unix and Control.len on Windows.

Trait Implementations

impl<'name, 'bufs, 'control> Debug for MsgHdrMut<'name, 'bufs, 'control>

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

Formats the value using the given formatter.