Struct libbpf_rs::RingBufferBuilder

pub struct RingBufferBuilder<'slf, 'cb> { /* private fields */ }

Builds RingBuffer instances.

ringbufs are a special kind of Map, used to transfer data between Programs and userspace. As of Linux 5.8, the ringbuf map is now preferred over the perf buffer.

Implementations

impl<'slf, 'cb: 'slf> RingBufferBuilder<'slf, 'cb>

pub fn new() -> Self

Create a new RingBufferBuilder object.

pub fn add<NewF>( &mut self, map: &'slf MapHandle, callback: NewF, ) -> Result<&mut Self>

where NewF: FnMut(&[u8]) -> i32 + 'cb,

Add a new ringbuf map and associated callback to this ring buffer manager. The callback should take one argument, a slice of raw bytes, and return an i32.

Non-zero return values in the callback will stop ring buffer consumption early.

The callback provides a raw byte slice. You may find libraries such as plain helpful.

pub fn build(self) -> Result<RingBuffer<'cb>>

Build a new RingBuffer. Must have added at least one ringbuf.

Trait Implementations

impl<'slf, 'cb> Debug for RingBufferBuilder<'slf, 'cb>

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

Formats the value using the given formatter.

impl<'slf, 'cb> Default for RingBufferBuilder<'slf, 'cb>

fn default() -> RingBufferBuilder<'slf, 'cb>

Returns the “default value” for a type.