Enum libbpf_rs::MapType

#[non_exhaustive]
#[repr(u32)]
pub enum MapType {
    Unspec = 0,
    Hash = 1,
    Array = 2,
    ProgArray = 3,
    PerfEventArray = 4,
    PercpuHash = 5,
    PercpuArray = 6,
    StackTrace = 7,
    CgroupArray = 8,
    LruHash = 9,
    LruPercpuHash = 10,
    LpmTrie = 11,
    ArrayOfMaps = 12,
    HashOfMaps = 13,
    Devmap = 14,
    Sockmap = 15,
    Cpumap = 16,
    Xskmap = 17,
    Sockhash = 18,
    CgroupStorage = 19,
    ReuseportSockarray = 20,
    PercpuCgroupStorage = 21,
    Queue = 22,
    Stack = 23,
    SkStorage = 24,
    DevmapHash = 25,
    StructOps = 26,
    RingBuf = 27,
    InodeStorage = 28,
    TaskStorage = 29,
    BloomFilter = 30,
    UserRingBuf = 31,
    Unknown = 4_294_967_295,
}

Type of a Map. Maps to enum bpf_map_type in kernel uapi.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Unspec = 0

Hash = 1

Array = 2

ProgArray = 3

PerfEventArray = 4

PercpuHash = 5

PercpuArray = 6

StackTrace = 7

CgroupArray = 8

LruHash = 9

LruPercpuHash = 10

LpmTrie = 11

ArrayOfMaps = 12

HashOfMaps = 13

Devmap = 14

Sockmap = 15

Cpumap = 16

Xskmap = 17

Sockhash = 18

CgroupStorage = 19

ReuseportSockarray = 20

PercpuCgroupStorage = 21

Queue = 22

Stack = 23

SkStorage = 24

DevmapHash = 25

StructOps = 26

RingBuf = 27

InodeStorage = 28

TaskStorage = 29

BloomFilter = 30

UserRingBuf = 31

Unknown = 4_294_967_295

We choose to specify our own “unknown” type here b/c it’s really up to the kernel to decide if it wants to reject the map. If it accepts it, it just means whoever using this library is a bit out of date.

Implementations

impl MapType

pub fn is_percpu(&self) -> bool

Returns if the map is of one of the per-cpu types.

pub fn is_bloom_filter(&self) -> bool

Returns if the map is of bloom filter type

pub fn is_supported(&self) -> Result<bool>

Detects if host kernel supports this BPF map type.

Make sure the process has required set of CAP_* permissions (or runs as root) when performing feature checking.

Trait Implementations

impl Clone for MapType

fn clone(&self) -> MapType

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MapType

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

Formats the value using the given formatter.

impl Display for MapType

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

Formats the value using the given formatter.

impl From<MapType> for u32

fn from(enum_value: MapType) -> Self

Converts to this type from the input type.

impl PartialEq for MapType

fn eq(&self, other: &MapType) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<u32> for MapType

type Error = TryFromPrimitiveError<MapType>

The type returned in the event of a conversion error.

fn try_from(number: u32) -> Result<Self, TryFromPrimitiveError<Self>>

Performs the conversion.

impl TryFromPrimitive for MapType

type Primitive = u32

const NAME: &'static str = "MapType"

fn try_from_primitive( number: Self::Primitive ) -> Result<Self, TryFromPrimitiveError<Self>>

impl Copy for MapType

impl Eq for MapType

impl StructuralPartialEq for MapType