Struct DataPacket

pub struct DataPacket<'a, T: RingMem> { /* private fields */ }

An incoming data packet.

Implementations

impl<T: RingMem> DataPacket<'_, T>

pub fn reader(&self) -> impl MemoryRead + '_

A reader for the data payload.

N.B. This reads the payload in place, so multiple instantiations of the reader may see multiple different results if the (malicious) opposite endpoint is mutating the ring buffer.

pub fn transaction_id(&self) -> Option<u64>

The packet’s transaction ID. Set if and only if a completion packet was requested.

pub fn external_range_count(&self) -> usize

The number of GPA direct ranges.

pub fn read_external_ranges( &self, ) -> Result<MultiPagedRangeBuf<GpnList>, ExternalDataError>

Reads the GPA direct range descriptors from the packet.

pub fn transfer_buffer_id(&self) -> Option<u16>

Reads the transfer buffer ID from the packet, or None if this is not a transfer packet.

pub fn read_transfer_ranges<'a, I>( &self, transfer_buf: I, ) -> Result<MultiPagedRangeBuf<GpnList>, AccessError>

where I: Iterator<Item = PagedRange<'a>>,

Reads the transfer descriptors from the packet using the provided buffer. This buffer should be the one associated with the value returned from transfer_buffer_id().