Struct libbpf_cargo::SkeletonBuilder

pub struct SkeletonBuilder { /* private fields */ }

SkeletonBuilder builds and generates a single skeleton.

This interface is meant to be used in build scripts.

Examples

use libbpf_cargo::SkeletonBuilder;

SkeletonBuilder::new("myobject.bpf.c")
    .debug(true)
    .clang("/opt/clang/clang")
    .generate("/output/path")
    .unwrap();

Implementations

impl SkeletonBuilder

pub fn new<P: AsRef<Path>>(source: P) -> Self

Create a new builder instance, where source is the path to the BPF object source (typically suffixed by .bpf.c)

pub fn debug(&mut self, debug: bool) -> &mut SkeletonBuilder

Turn debug output on or off

Default is off

pub fn clang<P: AsRef<Path>>(&mut self, clang: P) -> &mut SkeletonBuilder

Specify which clang binary to use

Default searchs $PATH for clang

pub fn clang_args<S: AsRef<str>>(&mut self, opts: S) -> &mut SkeletonBuilder

Pass additional arguments to clang when buildling BPF object file

Examples

use libbpf_cargo::SkeletonBuilder;

SkeletonBuilder::new("myobject.bpf.c")
    .clang_args("-DMACRO=value -I/some/include/dir")
    .generate("/output/path")
    .unwrap();

pub fn skip_clang_version_check(&mut self, skip: bool) -> &mut SkeletonBuilder

Specify whether or not to skip clang version check

Default is false

pub fn rustfmt<P: AsRef<Path>>(&mut self, rustfmt: P) -> &mut SkeletonBuilder

Specify which rustfmt binary to use

Default searches $PATH for rustfmt

pub fn generate<P: AsRef<Path>>(&self, output: P) -> Result<()>

Generate the skeleton at path output