7 releases

0.3.1 Jul 15, 2024
0.3.0 May 24, 2024
0.2.3 Nov 13, 2023
0.2.2 Oct 30, 2023
0.1.7 Aug 31, 2023

#249 in Parser tooling

Download history 48/week @ 2024-06-24 2/week @ 2024-07-01 307/week @ 2024-07-08 326/week @ 2024-07-15 79/week @ 2024-07-22 145/week @ 2024-07-29 245/week @ 2024-08-05 253/week @ 2024-08-12 285/week @ 2024-08-19 284/week @ 2024-08-26 353/week @ 2024-09-02 465/week @ 2024-09-09 140/week @ 2024-09-16 160/week @ 2024-09-23 422/week @ 2024-09-30 74/week @ 2024-10-07

799 downloads per month
Used in bumble

Apache-2.0

735KB
16K SLoC

Rust 13K SLoC // 0.1% comments Python 3K SLoC // 0.2% comments Pest 108 SLoC

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

Dependencies

~4–12MB
~137K SLoC