| commit | f6038e2860cacd838b7dcc18afa77eacd132bd17 | [log] [tgz] |
|---|---|---|
| author | Yongheng Chen <yongheng@google.com> | Fri Sep 06 10:59:41 2024 -0700 |
| committer | Copybara-Service <copybara-worker@google.com> | Fri Sep 06 11:01:09 2024 -0700 |
| tree | 15b38d71a7089fa62b52e4a49bae4a669eaa1248 | |
| parent | f729be37373e3c390b71e39e28c0435c53c0c580 [diff] |
Support reexported private symbols with `use`. If a private symbol is reexported, we generate C++ bindings for the symbol in an internal namespace so that users are warned not to directly use that symbol. If we reexport the symbol with multiple `use`s, all the aliases represent the same type. PiperOrigin-RevId: 671826238 Change-Id: Ib861969d19d463938198c2c5eea180bd475ea276
NOTE: Crubit currently expects deep integration with the build system, and is difficult to deploy to environments dissimilar to Google's monorepo. We do not have our tooling set up to accept external contributions at this time.
Crubit is a bidirectional bindings generator for C++ and Rust, with the goal of integrating the C++ and Rust ecosystems.
Support for calling FFI-friendly C++ from Rust is in progress.
Support for calling Rust from C++ will arrive in 2024H2.
Consider the following C++ function:
extern "C" bool IsGreater(int lhs, int rhs);
This function, if present in a header file which is processed by Crubit, becomes callable from Rust as if it were defined as:
pub fn IsGreater(lhs: ffi::c_int, rhs: ffi::c_int) -> bool {...}
Note: There are some temporary restrictions on the API shape. For example, functions that are not extern "C", or that accept a type like std::string, can't be called from Rust directly via Crubit. These restrictions will be relaxed over time.
Here are some resources for getting started with Crubit:
Rust Bindings for C++ Libraries is a detailed walkthrough on how to use C++ from Rust using Crubit.
The examples/cpp/ directory has copy-pastable examples of calling C++ from Rust, together with snapshots of what the generated Rust interface looks like.
$ apt install clang lld bazel $ git clone git@github.com:google/crubit.git $ cd crubit $ bazel build --linkopt=-fuse-ld=/usr/bin/ld.lld //rs_bindings_from_cc:rs_bindings_from_cc_impl
$ git clone https://github.com/llvm/llvm-project $ cd llvm-project $ CC=clang CXX=clang++ cmake -S llvm -B build -DLLVM_ENABLE_PROJECTS='clang' -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=install $ cmake --build build -j $ # wait... $ cmake --install build $ cd ../crubit $ LLVM_INSTALL_PATH=../llvm-project/install bazel build //rs_bindings_from_cc:rs_bindings_from_cc_impl