Struct io_uring::types::BufRingEntry

pub struct BufRingEntry(/* private fields */);

Implementations

impl BufRingEntry

An entry in a buf_ring that allows setting the address, length and buffer id.

pub fn set_addr(&mut self, addr: u64)

Sets the entry addr.

pub fn addr(&self) -> u64

Returns the entry addr.

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

Sets the entry len.

pub fn len(&self) -> u32

Returns the entry len.

pub fn set_bid(&mut self, bid: u16)

Sets the entry bid.

pub fn bid(&self) -> u16

Returns the entry bid.

pub unsafe fn tail(ring_base: *const BufRingEntry) -> *const u16

The offset to the ring’s tail field given the ring’s base address.

The caller should ensure the ring’s base address is aligned with the system’s page size, per the uring interface requirements.

Safety

The ptr will be dereferenced in order to determine the address of the resv field, so the caller is responsible for passing in a valid pointer. And not just a valid pointer type, but also the argument must be the address to the first entry of the buf_ring for the resv field to even be considered the tail field of the ring. The entry must also be properly initialized.