Enum AncillaryDataBuf

pub enum AncillaryDataBuf<'a> {
    Borrowed(&'a mut [u8]),
    Owned(Vec<u8>),
}

Available on Unix only.

A buffer used for receiving ancillary data from Unix domain sockets.

The actual ancillary data can be obtained using the decode method.

Example

See UdStream or UdStreamListener for an example of receiving ancillary data.

Variants

Borrowed(&'a mut [u8])

The buffer’s storage is borrowed.

Owned(Vec<u8>)

The buffer’s storage is owned by the buffer itself.

Implementations

impl<'a> AncillaryDataBuf<'a>

pub fn owned_with_capacity(capacity: usize) -> Self

Creates an owned ancillary data buffer with the specified capacity.

pub fn decode(&'a self) -> AncillaryDataDecoder<'a>

Creates a decoder which decodes the ancillary data buffer into a friendly representation of its contents.

All invalid ancillary data blocks are skipped – if there was garbage data in the buffer to begin with, the resulting buffer will either be empty or contain invalid credentials/file descriptors. This should normally never happen if the data is actually received from a Unix domain socket.

Trait Implementations

impl<'a> AsMut<[u8]> for AncillaryDataBuf<'a>

fn as_mut(&mut self) -> &mut [u8]

Converts this type into a mutable reference of the (usually inferred) input type.

impl<'a> AsRef<[u8]> for AncillaryDataBuf<'a>

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl<'a> Debug for AncillaryDataBuf<'a>

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

Formats the value using the given formatter.

impl<'a> From<&'a AncillaryDataBuf<'a>> for AncillaryDataDecoder<'a>

fn from(buffer: &'a AncillaryDataBuf<'a>) -> Self

Converts to this type from the input type.

impl<'a> From<&'a mut [u8]> for AncillaryDataBuf<'a>

fn from(op: &'a mut [u8]) -> Self

Converts to this type from the input type.

impl<'a> From<&'a mut AncillaryDataBuf<'a>> for AncillaryDataBuf<'a>

fn from(op: &'a mut AncillaryDataBuf<'a>) -> Self

Converts to this type from the input type.

impl From<Vec<u8>> for AncillaryDataBuf<'static>

fn from(op: Vec<u8>) -> Self

Converts to this type from the input type.