Google Git
Sign in
android / platform / external / rust / crates / pdl-runtime / 42955e2a200acb81007c67251964f3874b6f2d93
commit42955e2a200acb81007c67251964f3874b6f2d93[log] [tgz]
authorHenri Chataing <[email protected]>Thu Oct 19 15:34:32 2023 +0000
committerHenri Chataing <[email protected]>Mon Oct 23 17:10:44 2023 +0000
tree19bc6fbb8b36697fc0c5352fc51cc233385b885c
parent18ee7a9e1cce70a3839dd2a519d3c1301d682b2c [diff]
Import platform/external/rust/crates/pdl-runtime

Bug: 306901204
Change-Id: I551d341a021724ef2ada39b46f84e780fe1fc930
9 files changed
tree: 19bc6fbb8b36697fc0c5352fc51cc233385b885c
  1. src/
  2. Android.bp
  3. Cargo.toml
  4. Cargo.toml.orig
  5. LICENSE
  6. METADATA
  7. MODULE_LICENSE_APACHE2
  8. OWNERS
  9. README.md
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