Google Git
Sign in
android / platform / external / rust / crates / pdl-compiler / 10f007505aee23a9b5e72c09742e9292fd8b719a
commit10f007505aee23a9b5e72c09742e9292fd8b719a[log] [tgz]
authorJames Farrell <[email protected]>Thu Oct 05 21:37:22 2023 +0000
committerJames Farrell <[email protected]>Thu Oct 05 21:37:22 2023 +0000
tree8aa5a437407343de068b170301a097748b23eca8
parentb32d1823b491678db6f89438450945e8c973b5e2 [diff]
Update Android.bp to reflect aosp/2763825

Test: Ran cargo2android. Treehugger.
Change-Id: Ic4101aaf0ee2aec8ad932189c5dc5c7ba634c1cb
1 file changed
tree: 8aa5a437407343de068b170301a097748b23eca8
  1. doc/
  2. examples/
  3. patches/
  4. scripts/
  5. src/
  6. tests/
  7. .cargo_vcs_info.json
  8. .gitignore
  9. Android.bp
  10. Cargo.toml
  11. Cargo.toml.orig
  12. cargo2android.json
  13. cargo2android_toplevel.bp
  14. CONTRIBUTING.md
  15. LICENSE
  16. METADATA
  17. MODULE_LICENSE_APACHE2
  18. OWNERS
  19. README.md
  20. rustfmt.toml
README.md

Packet Description Language (PDL)

Crate Build workflow GitHub contributors GitHub stars

PDL is a domain specific language for writing the definition of binary protocol packets. Parsing and validating packets from raw bytes is tedious and error prone in any language. PDL generates memory safe and tailored backends for multiple target languages:

- Rust
- C++
- Python

Historically PDL was developed as part of the Android Bluetooth stack (bluetooth_packetgen) as a way to generate the parser and serializer for Bluetooth packets, and reduce the number of memory safety issues that come with manipulating and validating raw data.

How to use PDL

  1. Write the protocol definition
  2. cargo run my-protocol.pdl --output-format rust > my-protocol.rs

Language specific instructions are provided for all supported backends:

  1. Rust generated code guide
  2. Python generated code guide
  3. C++ generated code guide

Supported Features

Full reference documentation

  • Scalar values
  • Enumerators
  • Arrays
  • Nested packets
  • Conditional packet derivation
  • Custom field definitions

Similar projects