Struct PerfEventArrayBuffer 

pub struct PerfEventArrayBuffer<T> { /* private fields */ }

A ring buffer that can receive events from eBPF programs.

PerfEventArrayBuffer is a ring buffer that can receive events from eBPF programs that use bpf_perf_event_output(). It’s returned by PerfEventArray::open.

See the PerfEventArray documentation for an overview of how to use perf buffers.

Implementations

impl<T: BorrowMut<MapData>> PerfEventArrayBuffer<T>

pub fn readable(&self) -> bool

Returns true if the buffer contains events that haven’t been read.

pub fn try_fold<B, C, F>(&mut self, init: C, f: F) -> ControlFlow<B, C>

where F: FnMut(C, PerfEvent<'_>) -> ControlFlow<B, C>,

Processes events available in the buffer with f.

For each available event, f receives the accumulator and event:

• ControlFlow::Continue(next) keeps draining with next.
• ControlFlow::Break(break_value) stops early and returns break_value.

If the buffer is fully drained, returns ControlFlow::Continue containing the final accumulator.

The slices in PerfEvent::Sample are borrowed directly from the perf ring buffer; the borrow is bounded by the closure invocation. The kernel-visible data_tail is advanced once at the end of the call, amortizing the SeqCst store across the drain.

pub fn fold<C, F>(&mut self, init: C, f: F) -> C

where F: FnMut(C, PerfEvent<'_>) -> C,

Processes events available in the buffer with f.

For each available event, f receives the accumulator and event, and returns the next accumulator. Unlike PerfEventArrayBuffer::try_fold, this function cannot short-circuit: it always processes events until the buffer is fully drained, then returns the final accumulator.

pub fn for_each<F>(&mut self, f: F)

where F: FnMut(PerfEvent<'_>),

Processes events available in the buffer with f.

Trait Implementations

impl<T: BorrowMut<MapData>> AsFd for PerfEventArrayBuffer<T>

fn as_fd(&self) -> BorrowedFd<'_>

Borrows the file descriptor.

impl<T: BorrowMut<MapData>> AsRawFd for PerfEventArrayBuffer<T>

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.