Struct BufferGroup 

pub struct BufferGroup {
    pub group_id: u16,
    pub buffer_count: u32,
    pub buffer_size: u32,
    /* private fields */
}

Buffer selection group for managing provided buffers.

Allows the kernel to select buffers from a pre-registered pool, enabling zero-copy operations and reducing buffer management overhead.

Fields

group_id: u16

Group ID for this buffer set

buffer_count: u32

Number of buffers in the group

buffer_size: u32

Size of each buffer in bytes

Implementations

impl BufferGroup

pub fn new(group_id: u16, buffer_count: u32, buffer_size: u32) -> Result<Self>

Create a new buffer group with the specified parameters.

Arguments

• group_id - Unique identifier for this buffer group
• buffer_count - Number of buffers to allocate
• buffer_size - Size of each buffer in bytes

Errors

Returns an error if buffer allocation fails or parameters are invalid.

Examples

use safer_ring::advanced::BufferGroup;

let group = BufferGroup::new(1, 100, 4096)?;

pub fn get_buffer(&mut self) -> Option<u16>

Get the next available buffer index.

Returns None if no buffers are available.

pub fn return_buffer(&mut self, buffer_id: u16)

Return a buffer to the available pool.

Arguments

• buffer_id - The buffer index to return

Panics

Panics in debug mode if buffer_id is invalid.

pub fn available_count(&self) -> usize

Get the number of available buffers.

pub fn has_available(&self) -> bool

Check if any buffers are available.

pub fn utilization(&self) -> f64

Get the utilization ratio (0.0 to 1.0).

Returns the fraction of buffers currently in use.

Trait Implementations

impl Debug for BufferGroup

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

Formats the value using the given formatter.