commit | a876fc15e7d01ae73aa14fd5b02d637e9dfb7f85 | [log] [tgz] |
---|---|---|
author | Android Build Coastguard Worker <android-build-coastguard-worker@google.com> | Thu May 23 15:41:40 2024 +0000 |
committer | Android Build Coastguard Worker <android-build-coastguard-worker@google.com> | Thu May 23 15:41:40 2024 +0000 |
tree | bdfa7148579b8b541254cd8928a54a4bed3c978f | |
parent | cf58c6b58862e2b550d6f800865e8248d77ef5c5 [diff] | |
parent | 5fbb09598828832481def5ff463ee02c75925907 [diff] |
Snap for 11880863 from 5fbb09598828832481def5ff463ee02c75925907 to build-tools-release Change-Id: I09637d0c55da9fc1ef21e9e3a06cc39209d7351d
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 bindgen
minimum supported Rust version is 1.60.0.
The bindgen-cli
minimum supported Rust version is 1.64.0.
No MSRV bump policy has been established yet, so MSRV may increase in any release.
The MSRV is the minimum Rust version that can be used to compile each crate. However, bindgen
and bindgen-cli
can generate bindings that are compatible with Rust versions below the current MSRV.
Most of the time, the bindgen-cli
crate will have a more recent MSRV than bindgen
as crates such as clap
require it.
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).