Struct xsk_rs::umem::CompQueue

source · [−]

pub struct CompQueue { /* private fields */ }

Expand description

Used to transfer ownership of Umem frames from kernel-space to user-space.

Frames received in this queue are those that have been sent via the TxQueue.

For more information see the docs.

Implementations

impl CompQueue

pub unsafe fn consume(&mut self, descs: &mut [FrameDesc ]) -> usize

Update descs with details of frames whose contents have been sent (after submission via the TxQueue) and may now be used again. Returns the number of elements of descs which have been updated.

The number of entries updated will be less than or equal to the length of descs. Entries will be updated sequentially from the start of descs until the end.

Free frames should eventually be added back on to either the FillQueue or the TxQueue.

Safety

The frames passed to this queue must belong to the same Umem that this CompQueue instance is tied to.

pub unsafe fn consume_one(&mut self, desc: &mut FrameDesc) -> usize

Same as consume but for a single frame descriptor.

Safety

Trait Implementations

impl Debug for CompQueue

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

Formats the value using the given formatter. Read more

Auto Trait Implementations

impl RefUnwindSafe for CompQueue

impl Send for CompQueue

impl !Sync for CompQueue

impl Unpin for CompQueue

impl UnwindSafe for CompQueue

Blanket Implementations

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

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

const: unstable · 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.

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.