Go to file
2020-07-01 13:30:52 +02:00
.github Update broken links: Rust-lang-nursery => Rust-lang (#1447) 2018-11-24 15:36:57 +01:00
bindgen-integration Introduce tests for functional macros 2020-06-21 01:40:52 +02:00
book Update some docs that are not changelogs 2020-06-29 03:39:19 +02:00
ci ci: always try to find a nightly toolchain with rustfmt. 2020-06-15 02:13:39 +02:00
csmith-fuzzing Update Links 2019-05-21 13:41:42 +02:00
releases Update Links 2019-05-21 13:41:42 +02:00
src Refine test for C++ operators 2020-07-01 13:30:52 +02:00
tests Introduce expectation test for operator names 2020-07-01 13:30:52 +02:00
.gitattributes Always check out test headers and expectations as LF 2017-09-22 19:02:42 -07:00
.gitignore Fix gitignore so ripgrep works 2019-01-25 12:03:22 -05:00
.travis.yml Reorder jobs to reduce total runtime 2020-06-19 17:21:23 +02:00
appveyor.yml Add llvm 9.0 to CI. 2019-10-14 14:15:46 +02:00
build.rs Respect changes to BINDGEN_EXTRA_CLANG_ARGS 2020-06-22 11:40:35 +02:00
Cargo.lock Release 0.54.0. 2020-05-21 21:41:37 +02:00
Cargo.toml Release 0.54.0. 2020-05-21 21:41:37 +02:00
CHANGELOG.md Document the 0.53.3 release. 2020-05-21 21:51:54 +02:00
CONTRIBUTING.md Update Links 2019-05-21 13:41:42 +02:00
example-graphviz-ir.png Update the example graphviz image 2017-02-17 17:45:49 -08:00
LICENSE Regenerates the BSD3 License so GitHub recognises it 2018-07-05 14:16:28 +01:00
README.md Update some docs that are not changelogs 2020-06-29 03:39:19 +02:00
rustfmt.toml Rustfmt. 2019-09-17 11:53:23 +09:00

crates.io docs.rs

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);
}

Users Guide

📚 Read the bindgen users guide here! 📚

MSRV

The minimum supported Rust version is 1.34.

No MSRV bump policy has been established yet, so MSRV may increase in any release.

API Reference

API reference documentation is on docs.rs

Environment Variables

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
    • Arguments are whitespace-separated
    • Use shell-style quoting to pass through whitespace
    • Examples:
      • Specify alternate sysroot: --sysroot=/path/to/sysroot
      • Add include search path with spaces: -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.

Contributing

See CONTRIBUTING.md for hacking on bindgen!