A native binding generator for the Rust language.
rust-bindgen was originally ported from [clay's bindgen].
$ cargo install bindgen
Bindgen will be dynamically linked to your default clang version. See
clang-sys if you
want to use an other version or do a static link build. The clang-sys feature
static can be activated via the bindgen feature clang_sys/static.
$ bindgen <header> [<bindgen options>] [-- <clang options>]
See --help for a list of the supported options.
rust
bindgen!(header, options...)
The use of this plugin requires the use of a nightly compiler.
Options:
| Option Name | Type | Default | | ------------------- | ---- | ------- | | link | str | | | match | str | | | builtins | bool | true | | allowunknowntypes | bool | false | | clang_args | str | |
bindgen --link lua --builtins /usr/include/lua.h -o lua.rs
Cargo.toml
rust
[dependencies]
bindgen = "*"
main.rs
```rust
mod lua_bindings { bindgen!("/usr/include/lua.h", link="lua", builtins=true) } ```
Due to a known issue with include! (https://github.com/rust-lang/rfcs/issues/752) when generating
bindings in a build script and importing them with include!, you'll want to wrap the bindings
in a module before writing them to a file to avoid triggering the issue with top-level
attributes in include!. Some more discussion about this issue can be found
here.
Cargo.toml
```rust
[package]
...
name = "bindgen_ex"
build = "build.rs"
[build-dependencies] bindgen = "0.19.0" ```
build.rs
```rust
extern crate bindgen;
use std::io::prelude::*; use std::fs::File;
fn main(){
let mut bindings = bindgen::Builder::new("mylib.h");
bindings.link("mylib", bindgen::LinkType::Static);
// Generate the bindings to a string so we can wrap them
// instead of going through the write_to_file API.
let generatedbindings = bindings.generate().expect("Failed to generate bindings");
// Now open the file we'll write the generated bindings too
let mut file = File::create("mylib.rs").expect("Failed to open file");
// Wrap the bindings in a pub mod before writing bindgen's output
file.write(format!("pub mod {} {{\n", "mylib").asbytes()).unwrap();
file.write(generatedbindings.asbytes()).unwrap();
file.write(b"}").unwrap();
}
```
main.rs
```rust
include!("my_lib.rs");
fn main() { mylib::examplefunction(); } ```