Struct EbpfBufferPtr 

pub struct EbpfBufferPtr<'a> { /* private fields */ }

Wraps a pointer to buffer used in eBPF runtime, such as an eBPF maps entry. The referenced data may be access from multiple threads in parallel, which makes it unsafe to access it using standard Rust types. EbpfBufferPtr allows to access these buffers safely. It may be used to reference either a whole VMO allocated for and eBPF map or individual elements of that VMO (see slice()). The address and the size of the buffer are always 8-byte aligned.

Implementations

impl<'a> EbpfBufferPtr<'a>

pub const ALIGNMENT: usize

pub unsafe fn new(ptr: *mut u8, size: usize) -> Self

Creates a new EbpfBufferPtr from the specified pointer.

Safety

Caller must ensure that the buffer referenced by ptr is valid for lifetime 'a.

pub fn len(&self) -> usize

Size of the buffer in bytes.

pub fn raw_ptr(&self) -> *mut u8

Raw pointer to the start of the buffer.

pub fn get_ptr<T>(&self, offset: usize) -> Option<EbpfPtr<'a, T>>

Returns a pointer to a value of type T at the specified offset.

pub fn slice(&self, range: impl RangeBounds<usize>) -> Option<Self>

Returns pointer to the specified range in the buffer.

pub fn load_to_slice(&self, dst: &mut [MaybeUninit<u8>])

Loads contents of the buffer into the specified slice, dst must be of the same size as self.

pub fn load<const N: usize>(&self) -> SmallVec<[u8; N]>

Loads all buffer contents into a SmallVec.

pub fn store(&self, data: &[u8])

Stores data in the buffer. data must not be larger than the buffer.

pub fn copy(&self, src: &EbpfBufferPtr<'_>)

Copies the data from another EbpfBufferPtr. src may be smaller than self. In this case it’s copied to the beginning of self.

Trait Implementations

impl<'a> Clone for EbpfBufferPtr<'a>

fn clone(&self) -> EbpfBufferPtr<'a>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> From<&'a mut [u8]> for EbpfBufferPtr<'a>

fn from(value: &'a mut [u8]) -> Self

Converts to this type from the input type.

impl<'a, const N: usize> From<&'a mut [u8; N]> for EbpfBufferPtr<'a>

fn from(value: &'a mut [u8; N]) -> Self

Converts to this type from the input type.

impl<'a> From<&'a mut Vec<u8>> for EbpfBufferPtr<'a>

fn from(value: &'a mut Vec<u8>) -> Self

Converts to this type from the input type.

impl<'a> Copy for EbpfBufferPtr<'a>