#bindings #ffi #code-generation

build bindgen

Automatically generates Rust FFI bindings to C and C++ libraries

91 releases (40 breaking)

0.55.1 Aug 24, 2020
0.54.1 Jul 6, 2020
0.53.2 Mar 9, 2020
0.52.0 Nov 19, 2019
0.0.2 Nov 21, 2014

#1 in FFI

Download history 53189/week @ 2020-06-06 49726/week @ 2020-06-13 48923/week @ 2020-06-20 47301/week @ 2020-06-27 47249/week @ 2020-07-04 46699/week @ 2020-07-11 44960/week @ 2020-07-18 46440/week @ 2020-07-25 49701/week @ 2020-08-01 52751/week @ 2020-08-08 55958/week @ 2020-08-15 58130/week @ 2020-08-22 58020/week @ 2020-08-29 55346/week @ 2020-09-05 61253/week @ 2020-09-12 53900/week @ 2020-09-19

222,930 downloads per month
Used in 1,519 crates (713 directly)

BSD-3-Clause

1MB
19K SLoC

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.40.

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!

Dependencies

~3.5MB
~75K SLoC