Struct ArrayOfMaps 

pub struct ArrayOfMaps<T, V = MapData> { /* private fields */ }

An array of eBPF maps.

An ArrayOfMaps stores references to other eBPF maps.

Minimum kernel version

The minimum kernel version required to use this feature is 4.12.

Implementations

impl<T: Borrow<MapData>, V> ArrayOfMaps<T, V>

pub fn len(&self) -> u32

Returns the number of elements in the array.

This corresponds to the value of bpf_map_def::max_entries on the eBPF side.

pub fn is_empty(&self) -> bool

Returns true if the array is empty.

impl<T: Borrow<MapData>, V: FromMapData> ArrayOfMaps<T, V>

pub fn get(&self, index: &u32, flags: u64) -> Result<V, MapError>

Returns the inner map stored at the given index.

The inner map type V is determined by the type parameter on the ArrayOfMaps itself.

File descriptor cost

Each call opens a new file descriptor to the inner map. The caller owns the returned map and its FD is closed on drop. Avoid calling this in a tight loop without dropping previous results.

Errors

Returns MapError::OutOfBounds if index is out of bounds, MapError::SyscallError if bpf_map_lookup_elem fails.

impl<T: BorrowMut<MapData>, V: InnerMap> ArrayOfMaps<T, V>

pub fn set(&mut self, index: u32, value: &V, flags: u64) -> Result<(), MapError>

Sets the value of the element at the given index.

Errors

Returns MapError::OutOfBounds if index is out of bounds, MapError::SyscallError if bpf_map_update_elem fails.

impl<V> ArrayOfMaps<MapData, V>

pub fn pin<P: AsRef<Path>>(self, path: P) -> Result<(), PinError>

Pins the map to a BPF filesystem.

When a map is pinned it will remain loaded until the corresponding file is deleted. All parent directories in the given path must already exist.

Trait Implementations

impl<T: Debug, V> Debug for ArrayOfMaps<T, V>

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

Formats the value using the given formatter.

impl<'a, V: InnerMap> TryFrom<&'a Map> for ArrayOfMaps<&'a MapData, V>

type Error = MapError

The type returned in the event of a conversion error.

fn try_from(map: &'a Map) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a, V: InnerMap> TryFrom<&'a mut Map> for ArrayOfMaps<&'a mut MapData, V>

type Error = MapError

The type returned in the event of a conversion error.

fn try_from(map: &'a mut Map) -> Result<Self, Self::Error>

Performs the conversion.

impl<V: InnerMap> TryFrom<Map> for ArrayOfMaps<MapData, V>

type Error = MapError

The type returned in the event of a conversion error.

fn try_from(map: Map) -> Result<Self, Self::Error>

Performs the conversion.