commit | f597e2777355e358a8f2c5a96d98326f3bf624d9 | [log] [tgz] |
---|---|---|
author | Patrick Walton <pcwalton@mimiga.net> | Fri Apr 23 14:40:26 2021 -0700 |
committer | Emilio Cobos Álvarez <emilio@crisal.io> | Tue Apr 27 01:32:44 2021 +0200 |
tree | 0378356544cb863d1ef67af02ba8a204b45e8e83 | |
parent | 91ec529f54398e3fc457b6f1a1ba4c1cf928cf9d [diff] |
Translate types that were declared inside functions as opaque types. This fixes a panic with the following header: template<typename T> struct Foo {}; template<typename T> Foo<T> foo{}; void f() { struct Bar { Bar() {} }; foo<Bar>; } Because we don't parse the insides of function bodies, code like this could cause us to parse a type (here, `Bar`) that we didn't see in our initial pass, which can cause subtle problems. Closes #2036.
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"
BINDGEN_EXTRA_CLANG_ARGS_<TARGET>
: similar to BINDGEN_EXTRA_CLANG_ARGS
, but used to set per-target arguments to pass to clang. Useful to set system include directories in a target-specific way in cross-compilation environments with multiple targets. Has precedence over BINDGEN_EXTRA_CLANG_ARGS
.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.
We don't follow a specific release calendar, but if you need a release please file an issue requesting that (ping @emilio
for increased effectiveness).