1[](https://crates.io/crates/bindgen) 2[](https://docs.rs/bindgen/) 3 4# `bindgen` 5 6**`bindgen` automatically generates Rust FFI bindings to C (and some C++) libraries.** 7 8For example, given the C header `doggo.h`: 9 10```c 11typedef struct Doggo { 12 int many; 13 char wow; 14} Doggo; 15 16void eleven_out_of_ten_majestic_af(Doggo* pupper); 17``` 18 19`bindgen` produces Rust FFI code allowing you to call into the `doggo` library's 20functions and use its types: 21 22```rust 23/* automatically generated by rust-bindgen 0.99.9 */ 24 25#[repr(C)] 26pub struct Doggo { 27 pub many: ::std::os::raw::c_int, 28 pub wow: ::std::os::raw::c_char, 29} 30 31extern "C" { 32 pub fn eleven_out_of_ten_majestic_af(pupper: *mut Doggo); 33} 34``` 35 36## Users Guide 37 38[�� Read the `bindgen` users guide here! ��](https://rust-lang.github.io/rust-bindgen) 39 40## MSRV 41 42The minimum supported Rust version is **1.60.0**. 43 44No MSRV bump policy has been established yet, so MSRV may increase in any release. 45 46The MSRV is the minimum Rust version that can be used to *compile* `bindgen`. However, `bindgen` can generate bindings that are compatible with Rust versions below the current MSRV. 47 48## API Reference 49 50[API reference documentation is on docs.rs](https://docs.rs/bindgen) 51 52## Environment Variables 53 54In addition to the [library API](https://docs.rs/bindgen) and [executable command-line API][bindgen-cmdline], 55`bindgen` can be controlled through environment variables. 56 57End-users should set these environment variables to modify `bindgen`'s behavior without modifying the source code of direct consumers of `bindgen`. 58 59- `BINDGEN_EXTRA_CLANG_ARGS`: extra arguments to pass to `clang` 60 - Arguments are whitespace-separated 61 - Use shell-style quoting to pass through whitespace 62 - Examples: 63 - Specify alternate sysroot: `--sysroot=/path/to/sysroot` 64 - Add include search path with spaces: `-I"/path/with spaces"` 65- `BINDGEN_EXTRA_CLANG_ARGS_<TARGET>`: similar to `BINDGEN_EXTRA_CLANG_ARGS`, 66 but used to set per-target arguments to pass to clang. Useful to set system include 67 directories in a target-specific way in cross-compilation environments with multiple targets. 68 Has precedence over `BINDGEN_EXTRA_CLANG_ARGS`. 69 70Additionally, `bindgen` uses `libclang` to parse C and C++ header files. 71To modify how `bindgen` searches for `libclang`, see the [`clang-sys` documentation][clang-sys-env]. 72For more details on how `bindgen` uses `libclang`, see the [`bindgen` users guide][bindgen-book-clang]. 73 74## Releases 75 76We don't follow a specific release calendar, but if you need a release please 77file an issue requesting that (ping `@emilio` for increased effectiveness). 78 79## Contributing 80 81[See `CONTRIBUTING.md` for hacking on `bindgen`!](./CONTRIBUTING.md) 82 83[bindgen-cmdline]: https://rust-lang.github.io/rust-bindgen/command-line-usage.html 84[clang-sys-env]: https://github.com/KyleMayes/clang-sys#environment-variables 85[bindgen-book-clang]: https://rust-lang.github.io/rust-bindgen/requirements.html#clang 86
){kind=link}
){kind=link}