pub struct SendAncillaryBuffer<'buf, 'slice, 'fd> {
buffer: &'buf mut [u8],
length: usize,
_phantom: PhantomData<&'slice [BorrowedFd<'fd>]>,
}
Expand description
Buffer for sending ancillary messages with sendmsg
, sendmsg_v4
,
sendmsg_v6
, sendmsg_unix
, and sendmsg_any
.
Use the push
function to add messages to send.
Fields§
§buffer: &'buf mut [u8]
Raw byte buffer for messages.
length: usize
The amount of the buffer that is used.
_phantom: PhantomData<&'slice [BorrowedFd<'fd>]>
Phantom data for lifetime of &'slice [BorrowedFd<'fd>]
.
Implementations§
source§impl<'buf, 'slice, 'fd> SendAncillaryBuffer<'buf, 'slice, 'fd>
impl<'buf, 'slice, 'fd> SendAncillaryBuffer<'buf, 'slice, 'fd>
sourcepub fn new(buffer: &'buf mut [u8]) -> Self
pub fn new(buffer: &'buf mut [u8]) -> Self
Create a new, empty SendAncillaryBuffer
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 send
instead of sendmsg
.
§Examples
Allocate a buffer for a single file descriptor:
let mut space = [0; rustix::cmsg_space!(ScmRights(1))];
let mut cmsg_buffer = SendAncillaryBuffer::new(&mut space);
Allocate a buffer for credentials:
let mut space = [0; rustix::cmsg_space!(ScmCredentials(1))];
let mut cmsg_buffer = SendAncillaryBuffer::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 = SendAncillaryBuffer::new(&mut space);
sourcepub(crate) fn as_control_ptr(&mut self) -> *mut u8
pub(crate) fn as_control_ptr(&mut self) -> *mut u8
Returns a pointer to the message data.
sourcepub(crate) fn control_len(&self) -> usize
pub(crate) fn control_len(&self) -> usize
Returns the length of the message data.
sourcepub fn push(&mut self, msg: SendAncillaryMessage<'slice, 'fd>) -> bool
pub fn push(&mut self, msg: SendAncillaryMessage<'slice, 'fd>) -> bool
Add an ancillary message to the buffer.
Returns true
if the message was added successfully.
Trait Implementations§
source§impl Default for SendAncillaryBuffer<'_, '_, '_>
impl Default for SendAncillaryBuffer<'_, '_, '_>
source§impl<'slice, 'fd> Extend<SendAncillaryMessage<'slice, 'fd>> for SendAncillaryBuffer<'_, 'slice, 'fd>
impl<'slice, 'fd> Extend<SendAncillaryMessage<'slice, 'fd>> for SendAncillaryBuffer<'_, 'slice, 'fd>
source§fn extend<T: IntoIterator<Item = SendAncillaryMessage<'slice, 'fd>>>(
&mut self,
iter: T,
)
fn extend<T: IntoIterator<Item = SendAncillaryMessage<'slice, 'fd>>>( &mut self, iter: T, )
source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)