Struct libbpf_rs::Map

pub struct Map { /* fields omitted */ }

Represents a created map.

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

Implementations

impl Map

pub fn name(&self) -> &str

pub fn fd(&self) -> i32

Returns a file descriptor to the underlying map.

pub fn map_type(&self) -> MapType

pub fn key_size(&self) -> u32

Key size in bytes

pub fn value_size(&self) -> u32

Value size in bytes

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 from bpffs

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

Returns map value as Vec of u8.

key must have exactly Map::key_size() elements.

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

Deletes an element from the map.

key must have exactly Map::key_size() elements.

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

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

Note that this operation is currently only implemented in the kernel for MapType::Queue and MapType::Stack.

key must have exactly Map::key_size() elements.

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

Update an element.

key must have exactly Map::key_size() elements. value must have exatly Map::value_size() elements.