Struct OpenMapImpl

pub struct OpenMapImpl<'obj, T = ()> { /* private fields */ }

Represents a parsed but not yet loaded BPF map.

This object exposes operations that need to happen before the map is created.

Some methods require working with raw bytes. You may find libraries such as plain helpful.

Implementations

impl<'obj> OpenMapImpl<'obj>

pub fn new(object: &'obj bpf_map) -> Self

Create a new OpenMap from a ptr to a libbpf_sys::bpf_map.

pub fn name(&self) -> &OsStr

Retrieve the OpenMap’s name.

pub fn map_type(&self) -> MapType

Retrieve type of the map.

pub fn initial_value(&self) -> Option<&[u8]>

Retrieve the initial value of the map.

impl<'obj> OpenMapImpl<'obj, Mut>

pub fn new_mut(object: &'obj mut bpf_map) -> Self

Create a new OpenMapMut from a ptr to a libbpf_sys::bpf_map.

pub fn initial_value_mut(&mut self) -> Option<&mut [u8]>

Retrieve the initial value of the map.

pub fn set_map_ifindex(&mut self, idx: u32)

Bind map to a particular network device.

Used for offloading maps to hardware.

pub fn set_initial_value(&mut self, data: &[u8]) -> Result<()>

Set the initial value of the map.

pub fn set_type(&mut self, ty: MapType) -> Result<()>

Set the type of the map.

pub fn set_key_size(&mut self, size: u32) -> Result<()>

Set the key size of the map in bytes.

pub fn set_value_size(&mut self, size: u32) -> Result<()>

Set the value size of the map in bytes.

pub fn set_max_entries(&mut self, count: u32) -> Result<()>

Set the maximum number of entries this map can have.

pub fn set_map_flags(&mut self, flags: u32) -> Result<()>

Set flags on this map.

pub fn set_numa_node(&mut self, numa_node: u32) -> Result<()>

pub fn set_inner_map_fd(&mut self, inner_map_fd: BorrowedFd<'_>) -> Result<()>

pub fn set_map_extra(&mut self, map_extra: u64) -> Result<()>

pub fn set_autocreate(&mut self, autocreate: bool) -> Result<()>

Set whether or not libbpf should automatically create this map during load phase.

pub fn set_pin_path<P: AsRef<Path>>(&mut self, path: P) -> Result<()>

Set where the map should be pinned.

Note this does not actually create the pin.

pub fn reuse_fd(&mut self, fd: BorrowedFd<'_>) -> Result<()>

Reuse an fd for a BPF map

pub fn reuse_pinned_map<P: AsRef<Path>>(&mut self, path: P) -> Result<()>

Reuse an already-pinned map for self.

Trait Implementations

impl<T> AsRawLibbpf for OpenMapImpl<'_, T>

fn as_libbpf_object(&self) -> NonNull<Self::LibbpfType>

Retrieve the underlying libbpf_sys::bpf_map.

type LibbpfType = bpf_map

The underlying libbpf type.

impl<'obj, T: Debug> Debug for OpenMapImpl<'obj, T>

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

Formats the value using the given formatter.