Struct Array

pub struct Array<V: Copy + Default> { /* private fields */ }

An array that exposes an idiomatic Rust interface to an underlying BPF array.

Implementations

impl<V: Copy + Default> Array<V>

pub fn with_capacity(entries: u32) -> Result<Self, Error>

Creates a new BPF array with entries elements. The kernel zero-initializes all elements on creation.

Arguments

• entries - The number of elements in the array.

Example

use bpf_api::collections::Array;

let array = Array::<u32>::with_capacity(10).expect("Failed to create array");

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

Retrieves the value for a given element.

Arguments

• index - The element index to retrieve.

Example

use bpf_api::collections::Array;

let array = Array::<u32>::with_capacity(10).expect("Failed to create array");
assert_eq!(array.get(5).expect("Failed to get element 5"), 0);

pub fn set(&self, index: u32, value: V) -> Result<(), Error>

Sets the value at a given index.

Arguments

• index - The element index to retrieve.
• value - The new value.

Example

use bpf_api::collections::Array;

let array = Array::<u32>::with_capacity(10).expect("Failed to create array");
assert_eq!(array.get(5).expect("Failed to get element 5"), 0);
assert!(matches!(array.set(5, 10), Ok(_)));
assert_eq!(array.get(5).expect("Failed to get element 5"), 10);

pub fn get_identifier(&self) -> u32

Retrieve the BPF identifier for this map. This is the underlying file descriptor that’s used in eBPF programs.

Example

use bpf_api::collections::Array;

let array = Array::<u32>::with_capacity(10).expect("Failed to create array");
array.get_identifier();