Enum AncillaryData 

pub enum AncillaryData {
    Unix(UnixControlData),
    Ip(ControlMessage),
}

AncillaryData converts a cmsghdr into a representation suitable for passing around inside of starnix. In AF_UNIX/SCM_RIGHTS, for example, the file descrpitors will be turned into FileHandles that can be sent to other tasks.

An AncillaryData instance can be converted back into a cmsghdr. At that point the contained objects will be converted back to what can be stored in a cmsghdr. File handles, for example, will be added to the reading task’s files and the associated file descriptors will be stored in the cmsghdr.

Variants

Unix(UnixControlData)

Ip(ControlMessage)

Implementations

impl AncillaryData

pub fn from_cmsg( current_task: &CurrentTask, message: ControlMsg, ) -> Result<Self, Errno>

Creates a new AncillaryData instance representing the data in message.

Parameters

• current_task: The current task. Used to interpret SCM_RIGHTS messages.
• message: The message header to parse.

pub fn into_controlmsg<L>( self, locked: &mut Locked<L>, current_task: &CurrentTask, flags: SocketMessageFlags, ) -> Result<Option<ControlMsg>, Errno>

where L: LockEqualOrBefore<FileOpsCore>,

pub fn total_size(&self, current_task: &CurrentTask) -> usize

Returns the total size of all data in this message.

pub fn minimum_size(&self) -> usize

Returns the minimum size that can fit some amount of this message’s data.

pub fn into_bytes<L>( self, locked: &mut Locked<L>, current_task: &CurrentTask, flags: SocketMessageFlags, space_available: usize, ) -> Result<Vec<u8>, Errno>

where L: LockEqualOrBefore<FileOpsCore>,

Convert the message into bytes, truncating it if it exceeds the available space.

Trait Implementations

impl Clone for AncillaryData

fn clone(&self) -> AncillaryData

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AncillaryData

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

Formats the value using the given formatter.