Google Git
Sign in
bazel / crubit / f2384037f82f9abeee3766a2beb23b54a2b50f9e
commitf2384037f82f9abeee3766a2beb23b54a2b50f9e[log] [tgz]
authorDevin Jeanpierre <jeanpierreda@google.com>Fri Mar 10 14:26:27 2023 -0800
committerCopybara-Service <copybara-worker@google.com>Fri Mar 10 14:27:04 2023 -0800
tree6643a49147add264fb50ba1da2b1975d9876e134
parent68c7b62bc34d7b827dceb4e248f7527f93e4d6d4 [diff]
Use `#[serde(deny_unknown_fields)]` for IR.

https://serde.rs/container-attrs.html#deny_unknown_fields

Unknown fields are always a bug, since we control both serialization and deserialization and they both come from the same version of the codebase. (Unlike traditional deserialization code, we don't need to deal with data that was generated a long time ago.)

This is a common, and potentially confusing, source of bugs. As an example, during recent feature work I accidentally forgot to rename a field in `ir.rs` when renaming it in `ir.h`, and the result was that everything compiled and ran but did a subtly incorrect thing, which took time to debug. `deny_unknown_fields` would have prevented this.

(We don't need to stop using `default`, because a mismatch in name will show up as both an unknown field and a defaulted field -- it's never a major or confusing bug to just have a defaulted field with no corresponding unknown field.)

Note that the attribute isn't necessary for enums. [Fieldless enums](https://play.rust-lang.org/?version=stable&mode=debug&edition=2021&gist=aeedbefac83cb6e73eb459927dcc3682) fail as one might expect even without the attribute, but so do [fieldful enums](https://play.rust-lang.org/?version=stable&mode=debug&edition=2021&gist=b752164835f2b9d853f2ed1e669d1a36).

PiperOrigin-RevId: 515738803
1 file changed
tree: 6643a49147add264fb50ba1da2b1975d9876e134
  1. .bazelci/
  2. bazel/
  3. cc_bindings_from_rs/
  4. common/
  5. docs/
  6. lifetime_analysis/
  7. lifetime_annotations/
  8. migrator/
  9. nullability_verification/
  10. rs_bindings_from_cc/
  11. support/
  12. .bazelrc
  13. .gitignore
  14. BUILD
  15. Cargo.Bazel.lock
  16. CODE_OF_CONDUCT
  17. CONTRIBUTING
  18. LICENSE
  19. README.md
  20. WORKSPACE
README.md

Crubit: C++/Rust Bidirectional Interop Tool

Build status

Extremely experimental interop tooling for C++ and Rust.

Please don‘t use, this is an experiment and we don’t yet know where will it take us. There will be breaking changes without warning. Unfortunately, we can't take contributions at this point.

Building Crubit

$ 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

Using a prebuilt LLVM tree

$ 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