Struct Builder 

pub struct Builder { /* private fields */ }

Core builder to setup the bindings options

Implementations

impl Builder

pub fn set_compute_cap(&mut self, cap: usize)

Force to use a given compute capability

pub fn get_compute_cap(&self) -> Option<usize>

Returns the detected CUDA compute capability, if available.

pub fn kernel_paths<P: Into<PathBuf>>(self, paths: Vec<P>) -> Self

Setup the kernel paths. All path must be set at once and be valid files.

let builder = bindgen_cuda::Builder::default().kernel_paths(vec!["src/mykernel.cu"]);

pub fn watch<T, P>(self, paths: T) -> Self

where T: IntoIterator<Item = P>, P: Into<PathBuf>,

Setup the paths that the lib depend on but does not need to build

let builder =
bindgen_cuda::Builder::default().watch(vec!["kernels/"]);

pub fn include_paths<P: Into<PathBuf>>(self, paths: Vec<P>) -> Self

Setup the kernel paths. All path must be set at once and be valid files.

let builder = bindgen_cuda::Builder::default().include_paths(vec!["src/mykernel.cuh"]);

pub fn kernel_paths_glob(self, glob: &str) -> Self

Setup the kernels with a glob.

let builder = bindgen_cuda::Builder::default().kernel_paths_glob("src/**/*.cu");

pub fn include_paths_glob(self, glob: &str) -> Self

Setup the include files with a glob.

let builder = bindgen_cuda::Builder::default().kernel_paths_glob("src/**/*.cuh");

pub fn out_dir<P: Into<PathBuf>>(self, out_dir: P) -> Self

Modifies the output directory. By default this is OUT_DIR

let builder = bindgen_cuda::Builder::default().out_dir("out/");

pub fn arg(self, arg: &'static str) -> Self

Sets up extra nvcc compile arguments.

let builder = bindgen_cuda::Builder::default().arg("--expt-relaxed-constexpr");

pub fn cuda_root<P>(&mut self, path: P)

where P: Into<PathBuf>,

Forces the cuda root to a specific directory. By default all standard directories will be visited.

let builder = bindgen_cuda::Builder::default().cuda_root("/usr/local/cuda");

pub fn build_lib<P>(&self, out_file: P)

where P: Into<PathBuf>,

Consumes the builder and create a lib in the out_dir. It then needs to be linked against in your build.rs

let builder = bindgen_cuda::Builder::default().build_lib("libflash.a");
println!("cargo:rustc-link-lib=flash");

pub fn build_ptx(&self) -> Result<Bindings, Error>

Consumes the builder and outputs 1 ptx file for each kernels found. This function returns Bindings which can then be unused to create a rust source file that will include those kernels.

let bindings = bindgen_cuda::Builder::default().build_ptx().unwrap();
bindings.write("src/lib.rs").unwrap();

Trait Implementations

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Self

Returns the “default value” for a type.