Struct libbpf_rs::Object

pub struct Object { /* private fields */ }

Represents a loaded BPF object file.

An Object is logically in charge of all the contained Programs and Maps as well as the associated metadata and runtime state that underpins the userspace portions of BPF program execution. As a libbpf-rs user, you must keep the Object alive during the entire lifetime of your interaction with anything inside the Object.

Note that this is an explanation of the motivation – Rust’s lifetime system should already be enforcing this invariant.

Implementations

impl Object

pub unsafe fn from_ptr(ptr: NonNull<bpf_object>) -> Result<Self>

Takes ownership from pointer.

Safety

If ptr is not already loaded then further operations on the returned object are undefined.

It is not safe to manipulate ptr after this operation.

pub fn btf(&self) -> Result<Option<Btf<'_>>>

Parse the btf information associated with this bpf object.

pub fn map<T: AsRef<str>>(&self, name: T) -> Option<&Map>

Get a reference to Map with the name name, if one exists.

pub fn map_mut<T: AsRef<str>>(&mut self, name: T) -> Option<&mut Map>

Get a mutable reference to Map with the name name, if one exists.

pub fn maps_iter(&self) -> impl Iterator<Item = &Map>

Get an iterator over references to all Maps. Note that this will include automatically generated .data, .rodata, .bss, and .kconfig maps. You may wish to filter this.

pub fn maps_iter_mut(&mut self) -> impl Iterator<Item = &mut Map>

Get an iterator over mutable references to all Maps. Note that this will include automatically generated .data, .rodata, .bss, and .kconfig maps. You may wish to filter this.

pub fn prog<T: AsRef<str>>(&self, name: T) -> Option<&Program>

Get a reference to Program with the name name, if one exists.

pub fn prog_mut<T: AsRef<str>>(&mut self, name: T) -> Option<&mut Program>

Get a mutable reference to Program with the name name, if one exists.

pub fn progs_iter(&self) -> impl Iterator<Item = &Program>

Get an iterator over references to all Programs.

pub fn progs_iter_mut(&mut self) -> impl Iterator<Item = &mut Program>

Get an iterator over mutable references to all Programs.

Trait Implementations

impl AsRawLibbpf for Object

fn as_libbpf_object(&self) -> NonNull<Self::LibbpfType>

Retrieve the underlying libbpf_sys::bpf_object.

type LibbpfType = bpf_object

The underlying libbpf type.

impl Debug for Object

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

Formats the value using the given formatter.

impl Drop for Object

fn drop(&mut self)

Executes the destructor for this type.