Struct libbpf_rs::RingBufferBuilder

pub struct RingBufferBuilder { /* fields omitted */ }

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 RingBufferBuilder

pub fn new() -> Self

pub fn add<NewF>(&mut self, map: &Map, callback: NewF) -> Result<&mut Self> where
    NewF: FnMut(&[u8]) -> i32 + 'static, 

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>

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

Trait Implementations

impl Default for RingBufferBuilder

pub fn default() -> RingBufferBuilder

Returns the "default value" for a type.