Skip to main content

RingType

Enum RingType 

Source
pub enum RingType {
    Tx,
    Rx,
    Fill,
    Completion,
}
Expand description

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§

Source§

impl RingType

Source

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.
Source

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§

Source§

impl Clone for RingType

Source§

fn clone(&self) -> RingType

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for RingType

Source§

impl Debug for RingType

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for RingType

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl StructuralPartialEq for RingType

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.