Struct Cursor 

pub struct Cursor<T: Copy> { /* private fields */ }

A structure for tracking a ring shared between a producer and consumer

See xsk.h.

Implementations

impl<T: Copy> Cursor<T>

pub fn producer(&self) -> &AtomicU32

Returns a reference to the producer atomic cursor

pub fn consumer(&self) -> &AtomicU32

Returns a reference to the producer atomic cursor

pub const fn capacity(&self) -> u32

Returns the overall size of the ring

pub fn acquire_producer(&mut self, watermark: u32) -> u32

Acquires a cursor index for a producer half

The watermark can be provided to avoid synchronization by reusing the cached cursor value.

See xsk.h.

pub fn cached_producer(&self) -> u32

Returns the cached producer cursor which is also maxed by the cursor mask

See xsk.h.

pub fn cached_producer_len(&self) -> u32

Returns the cached number of available entries for the consumer

See xsk.h.

pub fn release_producer(&mut self, len: u32)

Releases a len number of entries from the producer to the consumer.

See xsk.h.

The provided len should not exceed the number from acquire_producer. With debug_assertions enabled, this will panic if it occurs.

pub fn acquire_consumer(&mut self, watermark: u32) -> u32

Acquires a cursor index for a consumer half

The watermark can be provided to avoid synchronization by reusing the cached cursor value.

See xsk.h.

pub fn cached_consumer(&self) -> u32

Returns the cached consumer cursor which is also maxed by the cursor mask

See xsk.h.

pub fn cached_consumer_len(&self) -> u32

Returns the cached number of available entries for the consumer

See xsk.h.

pub fn release_consumer(&mut self, len: u32)

Releases a len number of entries from the consumer to the producer.

See xsk.h.

The provided len should not exceed the number from acquire_consumer. With debug_assertions enabled, this will panic if it occurs.

pub unsafe fn consumer_data(&mut self) -> (&mut [T], &mut [T])

Returns the current consumer entries

Safety

This function MUST only be used by the consumer side.

pub unsafe fn producer_data(&mut self) -> (&mut [T], &mut [T])

Returns the current producer entries

Safety

This function MUST only be used by the producer side.

pub const fn data_ptr(&self) -> NonNull<T>

Trait Implementations

impl<T: Debug + Copy> Debug for Cursor<T>

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

Formats the value using the given formatter.