Google Git
Sign in
android / platform / external / rust / crates / pdl-compiler / e5f3986d1e740294e1dcc174b54d50e2a1fe841f
commite5f3986d1e740294e1dcc174b54d50e2a1fe841f[log] [tgz]
authorTreehugger Robot <[email protected]>Thu Nov 16 20:41:53 2023 +0000
committerAutomerger Merge Worker <[email protected]>Thu Nov 16 20:41:53 2023 +0000
treed261c5021cf1151e37b78b4c190a16037bd0575e
parent949c9ba599f735bb127cbc70d7f88d2cc8002dce [diff]
parentfe2c5a9ad2c302383df75fcc136fd8629cfd0d9f [diff]
Merge "Migrate to cargo_embargo." into main am: 6d93ae5605 am: 9f0d5f95b0 am: fe2c5a9ad2

Original change: https://android-review.googlesource.com/c/platform/external/rust/crates/pdl-compiler/+/2828248

Change-Id: Id73b79b959033cfff132f8d90e391d5fda4128cb
Signed-off-by: Automerger Merge Worker <[email protected]>
tree: d261c5021cf1151e37b78b4c190a16037bd0575e
  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_toplevel.bp
  13. cargo_embargo.json
  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
  • Optional fields
  • Nested packets
  • Conditional packet derivation
  • Custom field definitions

Similar projects