commit | f3e4ca3ab4ee40069728fdb0add8ebcc2c551b7e | [log] [tgz] |
---|---|---|
author | Scott Lobdell <slobdell@google.com> | Thu Nov 05 18:29:05 2020 -0800 |
committer | Scott Lobdell <slobdell@google.com> | Thu Nov 05 18:29:05 2020 -0800 |
tree | 0f93135ff8610d38cdafd66865ab2f443592ab27 | |
parent | 83fd6bd753c70e1bed3787233d00ae2a0a053f09 [diff] | |
parent | 988501b9e4d558ce2197806848a38d292c1c17a4 [diff] |
Merge SP1A.201105.002 Change-Id: Ia2b3acfc337f4d8953bfdf5a69bc0d385da21fae
bindgen
bindgen
automatically generates Rust FFI bindings to C (and some C++) libraries.
For example, given the C header doggo.h
:
typedef struct Doggo { int many; char wow; } Doggo; void eleven_out_of_ten_majestic_af(Doggo* pupper);
bindgen
produces Rust FFI code allowing you to call into the doggo
library's functions and use its types:
/* automatically generated by rust-bindgen 0.99.9 */ #[repr(C)] pub struct Doggo { pub many: ::std::os::raw::c_int, pub wow: ::std::os::raw::c_char, } extern "C" { pub fn eleven_out_of_ten_majestic_af(pupper: *mut Doggo); }
📚 Read the bindgen
users guide here! 📚
The minimum supported Rust version is 1.40.
No MSRV bump policy has been established yet, so MSRV may increase in any release.
API reference documentation is on docs.rs
In addition to the library API and executable command-line API, bindgen
can be controlled through environment variables.
End-users should set these environment variables to modify bindgen
's behavior without modifying the source code of direct consumers of bindgen
.
BINDGEN_EXTRA_CLANG_ARGS
: extra arguments to pass to clang
--sysroot=/path/to/sysroot
-I"/path/with spaces"
Additionally, bindgen
uses libclang
to parse C and C++ header files. To modify how bindgen
searches for libclang
, see the clang-sys
documentation. For more details on how bindgen
uses libclang
, see the bindgen
users guide.