Struct MapImpl

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

Represents a libbpf-created map.

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

Implementations

impl<'obj> MapImpl<'obj>

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

Create a Map from a libbpf_sys::bpf_map.

pub fn is_pinned(&self) -> bool

Returns whether map is pinned or not flag

pub fn get_pin_path(&self) -> Option<&OsStr>

Returns the pin_path if the map is pinned, otherwise, None is returned

impl<'obj> MapImpl<'obj, Mut>

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

Create a MapMut from a libbpf_sys::bpf_map.

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

Pin this map to bpffs.

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

Unpin this map from bpffs.

pub fn attach_struct_ops(&mut self) -> Result<Link>

Attach a struct ops map

Trait Implementations

impl<T> AsFd for MapImpl<'_, T>

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

Borrows the file descriptor.

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

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

Formats the value using the given formatter.

impl<T> MapCore for MapImpl<'_, T>

where T: Debug,

fn name(&self) -> &OsStr

Retrieve the map’s name.

fn map_type(&self) -> MapType

Retrieve type of the map.

fn key_size(&self) -> u32

Retrieve the size of the map’s keys.

fn value_size(&self) -> u32

Retrieve the size of the map’s values.

fn info(&self) -> Result<MapInfo>

Fetch extra map information

fn keys(&self) -> MapKeyIter<'_>

Returns an iterator over keys in this map

fn lookup(&self, key: &[u8], flags: MapFlags) -> Result<Option<Vec<u8>>>

Returns map value as Vec of u8.

fn lookup_bloom_filter(&self, value: &[u8]) -> Result<bool>

Returns if the given value is likely present in bloom_filter as bool.

fn lookup_percpu( &self, key: &[u8], flags: MapFlags, ) -> Result<Option<Vec<Vec<u8>>>>

Returns one value per cpu as Vec of Vec of u8 for per per-cpu maps.

fn delete(&self, key: &[u8]) -> Result<()>

Deletes an element from the map.

fn delete_batch( &self, keys: &[u8], count: u32, elem_flags: MapFlags, flags: MapFlags, ) -> Result<()>

Deletes many elements in batch mode from the map.

fn lookup_and_delete(&self, key: &[u8]) -> Result<Option<Vec<u8>>>

Same as Self::lookup() except this also deletes the key from the map.

fn update(&self, key: &[u8], value: &[u8], flags: MapFlags) -> Result<()>

Update an element.

fn update_batch( &self, keys: &[u8], values: &[u8], count: u32, elem_flags: MapFlags, flags: MapFlags, ) -> Result<()>

Updates many elements in batch mode in the map

fn update_percpu( &self, key: &[u8], values: &[Vec<u8>], flags: MapFlags, ) -> Result<()>

Update an element in an per-cpu map with one value per cpu.

impl<T> TryFrom<&MapImpl<'_, T>> for MapHandle

where T: Debug,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(other: &MapImpl<'_, T>) -> Result<Self>

Performs the conversion.