Enum Map 

pub enum Map {
    Array(MapData),
    ArrayOfMaps(MapData),
    BloomFilter(MapData),
    CgroupArray(MapData),
    CpuMap(MapData),
    DevMap(MapData),
    DevMapHash(MapData),
    HashMap(MapData),
    HashOfMaps(MapData),
    InodeStorage(MapData),
    LpmTrie(MapData),
    LruHashMap(MapData),
    PerCpuArray(MapData),
    PerCpuHashMap(MapData),
    PerCpuLruHashMap(MapData),
    PerfEventArray(MapData),
    ProgramArray(MapData),
    Queue(MapData),
    ReusePortSockArray(MapData),
    RingBuf(MapData),
    SockHash(MapData),
    SockMap(MapData),
    SkStorage(MapData),
    Stack(MapData),
    StackTraceMap(MapData),
    Unsupported(MapData),
    XskMap(MapData),
}

eBPF map types.

Variants

Array(MapData)

An Array map.

ArrayOfMaps(MapData)

An ArrayOfMaps map.

BloomFilter(MapData)

A BloomFilter map.

CgroupArray(MapData)

A CgroupArray map.

CpuMap(MapData)

A CpuMap map.

DevMap(MapData)

A DevMap map.

DevMapHash(MapData)

A DevMapHash map.

HashMap(MapData)

A HashMap map.

HashOfMaps(MapData)

A HashOfMaps map.

InodeStorage(MapData)

An InodeStorage map.

LpmTrie(MapData)

A LpmTrie map.

LruHashMap(MapData)

A HashMap map that uses a LRU eviction policy.

PerCpuArray(MapData)

A PerCpuArray map.

PerCpuHashMap(MapData)

A PerCpuHashMap map.

PerCpuLruHashMap(MapData)

A PerCpuHashMap map that uses a LRU eviction policy.

PerfEventArray(MapData)

A PerfEventArray map.

ProgramArray(MapData)

A ProgramArray map.

Queue(MapData)

A Queue map.

ReusePortSockArray(MapData)

A ReusePortSockArray map.

RingBuf(MapData)

A RingBuf map.

SockHash(MapData)

A SockHash map

SockMap(MapData)

A SockMap map.

SkStorage(MapData)

A SkStorage map.

Stack(MapData)

A Stack map.

StackTraceMap(MapData)

A StackTraceMap map.

Unsupported(MapData)

An unsupported map type.

XskMap(MapData)

A XskMap map.

Implementations

impl Map

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.

pub fn from_map_data(map_data: MapData) -> Result<Self, MapError>

Constructs a Map enum variant directly from a MapData instance. This allows creating a user-space handle to a pinned BPF map.

Arguments

• map_data - The map data obtained from MapData::from_pin.

Errors

Returns an error if the map type is not supported.

Trait Implementations

impl Debug for Map

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

Formats the value using the given formatter.

impl<'a, V: Pod> TryFrom<&'a Map> for Array<&'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 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: Pod> TryFrom<&'a Map> for BloomFilter<&'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> TryFrom<&'a Map> for CgroupArray<&'a MapData>

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> TryFrom<&'a Map> for CpuMap<&'a MapData>

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> TryFrom<&'a Map> for DevMap<&'a MapData>

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> TryFrom<&'a Map> for DevMapHash<&'a MapData>

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, K: Pod, V: Pod> TryFrom<&'a Map> for HashMap<&'a MapData, K, 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, K: Pod, V: InnerMap> TryFrom<&'a Map> for HashOfMaps<&'a MapData, K, 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: Pod> TryFrom<&'a Map> for InodeStorage<&'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, K: Pod, V: Pod> TryFrom<&'a Map> for LpmTrie<&'a MapData, K, 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: Pod> TryFrom<&'a Map> for PerCpuArray<&'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, K: Pod, V: Pod> TryFrom<&'a Map> for PerCpuHashMap<&'a MapData, K, 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> TryFrom<&'a Map> for PerfEventArray<&'a MapData>

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> TryFrom<&'a Map> for ProgramArray<&'a MapData>

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: Pod> TryFrom<&'a Map> for Queue<&'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> TryFrom<&'a Map> for ReusePortSockArray<&'a MapData>

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> TryFrom<&'a Map> for RingBuf<&'a MapData>

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: Pod> TryFrom<&'a Map> for SkStorage<&'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: Pod> TryFrom<&'a Map> for SockHash<&'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> TryFrom<&'a Map> for SockMap<&'a MapData>

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: Pod> TryFrom<&'a Map> for Stack<&'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> TryFrom<&'a Map> for StackTraceMap<&'a MapData>

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> TryFrom<&'a Map> for XskMap<&'a MapData>

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: Pod> TryFrom<&'a mut Map> for Array<&'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<'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<'a, V: Pod> TryFrom<&'a mut Map> for BloomFilter<&'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<'a> TryFrom<&'a mut Map> for CgroupArray<&'a mut MapData>

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<'a> TryFrom<&'a mut Map> for CpuMap<&'a mut MapData>

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<'a> TryFrom<&'a mut Map> for DevMap<&'a mut MapData>

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<'a> TryFrom<&'a mut Map> for DevMapHash<&'a mut MapData>

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<'a, K: Pod, V: Pod> TryFrom<&'a mut Map> for HashMap<&'a mut MapData, K, 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<'a, K: Pod, V: InnerMap> TryFrom<&'a mut Map> for HashOfMaps<&'a mut MapData, K, 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<'a, V: Pod> TryFrom<&'a mut Map> for InodeStorage<&'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<'a, K: Pod, V: Pod> TryFrom<&'a mut Map> for LpmTrie<&'a mut MapData, K, 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<'a, V: Pod> TryFrom<&'a mut Map> for PerCpuArray<&'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<'a, K: Pod, V: Pod> TryFrom<&'a mut Map> for PerCpuHashMap<&'a mut MapData, K, 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<'a> TryFrom<&'a mut Map> for PerfEventArray<&'a mut MapData>

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<'a> TryFrom<&'a mut Map> for ProgramArray<&'a mut MapData>

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<'a, V: Pod> TryFrom<&'a mut Map> for Queue<&'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<'a> TryFrom<&'a mut Map> for ReusePortSockArray<&'a mut MapData>

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<'a> TryFrom<&'a mut Map> for RingBuf<&'a mut MapData>

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<'a, V: Pod> TryFrom<&'a mut Map> for SkStorage<&'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<'a, V: Pod> TryFrom<&'a mut Map> for SockHash<&'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<'a> TryFrom<&'a mut Map> for SockMap<&'a mut MapData>

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<'a, V: Pod> TryFrom<&'a mut Map> for Stack<&'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<'a> TryFrom<&'a mut Map> for StackTraceMap<&'a mut MapData>

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<'a> TryFrom<&'a mut Map> for XskMap<&'a mut MapData>

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: Pod> TryFrom<Map> for Array<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.

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.

impl<V: Pod> TryFrom<Map> for BloomFilter<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.

impl TryFrom<Map> for CgroupArray<MapData>

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.

impl TryFrom<Map> for CpuMap<MapData>

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.

impl TryFrom<Map> for DevMap<MapData>

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.

impl TryFrom<Map> for DevMapHash<MapData>

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.

impl<K: Pod, V: Pod> TryFrom<Map> for HashMap<MapData, K, 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.

impl<K: Pod, V: InnerMap> TryFrom<Map> for HashOfMaps<MapData, K, 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.

impl<V: Pod> TryFrom<Map> for InodeStorage<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.

impl<K: Pod, V: Pod> TryFrom<Map> for LpmTrie<MapData, K, 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.

impl<V: Pod> TryFrom<Map> for PerCpuArray<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.

impl<K: Pod, V: Pod> TryFrom<Map> for PerCpuHashMap<MapData, K, 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.

impl TryFrom<Map> for PerfEventArray<MapData>

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.

impl TryFrom<Map> for ProgramArray<MapData>

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.

impl<V: Pod> TryFrom<Map> for Queue<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.

impl TryFrom<Map> for ReusePortSockArray<MapData>

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.

impl TryFrom<Map> for RingBuf<MapData>

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.

impl<V: Pod> TryFrom<Map> for SkStorage<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.

impl<V: Pod> TryFrom<Map> for SockHash<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.

impl TryFrom<Map> for SockMap<MapData>

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.

impl<V: Pod> TryFrom<Map> for Stack<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.

impl TryFrom<Map> for StackTraceMap<MapData>

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.

impl TryFrom<Map> for XskMap<MapData>

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.