Enum RingType

pub enum RingType {
    Tx,
    Rx,
    Fill,
    Completion,
}

An enum representing the four types of AF_XDP rings.

Variants

Tx

The Transmit (TX) ring, for sending packets.

Rx

The Receive (RX) ring, for receiving packets.

Fill

The Fill ring, for providing the kernel with free UMEM frames.

Completion

The Completion ring, for retrieving used UMEM frames from the kernel.

Implementations

impl RingType

pub fn set_size(self, raw_fd: c_int, ring_size: usize) -> Result<()>

Sets the size of a specific ring via setsockopt.

Arguments

• raw_fd - The raw file descriptor of the XDP socket.
• ring_size - The number of descriptors for the ring.

pub fn mmap<T: Copy>( self, raw_fd: c_int, offsets: &xdp_mmap_offsets, ring_size: usize, ) -> Result<Ring<T>>

Memory-maps a ring of a specific type.

This is a convenience method that selects the correct offsets from xdp_mmap_offsets based on the RingType and then calls the generic Ring::mmap function.

Arguments

• raw_fd - The raw file descriptor of the XDP socket.
• offsets - The struct containing the memory map offsets for all rings.
• ring_size - The number of descriptors for the ring.

Trait Implementations

impl Clone for RingType

fn clone(&self) -> RingType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RingType

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

Formats the value using the given formatter.

impl PartialEq for RingType

fn eq(&self, other: &RingType) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for RingType

impl StructuralPartialEq for RingType