Struct xsk_rs::umem::frame::FrameDesc

pub struct FrameDesc { /* private fields */ }

A Umem frame descriptor.

Used to pass frame information between the kernel and userspace. addr is an offset in bytes from the start of the Umem and corresponds to the starting address of the packet data segment of some frame. lengths describes the length (in bytes) of any data stored in the frame’s headroom or data segments.

Implementations

impl FrameDesc

pub fn addr(&self) -> usize

The starting address of the packet data segment of the frame pointed at by this descriptor.

pub fn lengths(&self) -> &SegmentLengths

Current headroom and packet data lengths for the frame pointed at by this descriptor.

pub fn options(&self) -> u32

Frame options.

pub fn set_options(&mut self, options: u32)

Set the frame options.

Trait Implementations

impl Clone for FrameDesc

fn clone(&self) -> FrameDesc

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FrameDesc

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

Formats the value using the given formatter.

impl Default for FrameDesc

fn default() -> Self

Creates an empty frame descriptor with an address of zero and segment lengths also set to zero.

Since the address of any descriptors created this way is always zero, before using them to write to the Umem they should first be ‘initialised’ by passing them to either the RxQueue or the CompQueue, so they can be populated with the details of a free frame.

impl Copy for FrameDesc