Skip to main content

CompletionRing

Struct CompletionRing 

Source
pub struct CompletionRing { /* private fields */ }
Expand description

Ring buffer for UMEM completion descriptors (chunk addresses pushed by kernel/NIC after TX completion).

Implementations§

Source§

impl CompletionRing

Source

pub fn new(capacity: u32) -> Self

Creates a new completion ring with capacity descriptors. capacity must be a power of two.

Source

pub fn capacity(&self) -> u32

Maximum number of descriptors the ring can hold.

Source

pub fn len(&self) -> usize

Number of descriptors currently queued in the ring.

Source

pub fn is_empty(&self) -> bool

Returns true if the ring has no queued descriptors.

Source

pub fn is_full(&self) -> bool

Returns true if the ring is at maximum capacity.

Source

pub fn produce(&mut self, addr: u64) -> bool

Enqueues a chunk address into the completion ring. Returns false if full.

Source

pub fn produce_batch(&mut self, addrs: &[u64]) -> usize

Enqueues a batch of chunk addresses into the ring. Returns count enqueued.

Source

pub fn consume(&mut self) -> Option<u64>

Dequeues a completed chunk address from the ring.

Source

pub fn consume_batch(&mut self, out: &mut [u64]) -> usize

Dequeues up to out.len() chunk addresses into out. Returns count dequeued.

Trait Implementations§

Source§

impl Clone for CompletionRing

Source§

fn clone(&self) -> Self

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 Debug for CompletionRing

Source§

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

Formats the value using the given formatter. Read more

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 = !

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

fn try_from(value: U) -> Result<T, !>

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.