Struct xsk_rs::config::UmemConfig

pub struct UmemConfig { /* private fields */ }

Config for a Umem instance.

It’s worth noting that the specified frame_size is not necessarily the buffer size that will be available to write data into. Some of this will be eaten up by XDP program headroom (XDP_PACKET_HEADROOM) and any non-zero frame_headroom. Use the mtu function to determine whether the frame is large enough to hold the data you wish to transmit.

Implementations

impl Config

pub fn builder() -> ConfigBuilder

Creates a new UmemConfigBuilder instance with with sizes as per the libbpf defaults.

pub fn frame_size(&self) -> FrameSize

The size of each frame in the Umem.

pub fn fill_queue_size(&self) -> QueueSize

The FillQueue size.

pub fn comp_queue_size(&self) -> QueueSize

The CompQueue size.

pub fn xdp_headroom(&self) -> u32

The frame headroom reserved for the XDP program.

pub fn frame_headroom(&self) -> u32

The frame headroom available to the user.

pub fn mtu(&self) -> u32

The maximum transmission unit, or the length of the packet data segment of the frame.

Is defined as the frame size minus both the XDP headroom and user headroom.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.

impl From<Config> for xsk_umem_config

fn from(c: Config) -> Self

Performs the conversion.

impl Copy for Config