Converts XDR RPC definitions into Rust Services
rust-xdr is a framework for building Rust services from XDR RPC specifications. This is 2 parts
serde_xdr: A serialization/deserialization library implemented ontop ofserde. This is a stand-alone crate as well.rust-xdr: A code generator for tokio based services. This depends onserde_xdrfor serialization and some of the runtime code.
Assuming a Rust/Cargo install
$ cargo install xdrgen
$ xdrgen --input <files that define your service or types> --output <directory>
If you are attempting to only use serde_xdr be aware that discrimant unions require extra serde
annotations due to limitations of XDR. The examples directory shows how to properly annotate these
if you are not codegening off a XDR file (which generates the annotations for you)
See the /examples directory.
-
/examples/xdr_protocol_example/shows how the XDR protocol implementation is primarily codegenned off the RPC XDR specification. -
/examples/rust_xdr_serviceshows how to implement a service. The main.rs & service.rs are hand written files./examples/rust_xdr_service/xdrgenis the output directory ofxdrgen.cargo run --bin rust-xdr -- -i examples/example_prot.v --output examples/service_example/xdrgen
Built primarily during OkCupid Hack Week 2017, the goal of the project was to Proof Of Concept standing up Rust services that could easily interop with our existing C++ ones. Beyond building a typesafe (de)serialization library, we also wanted to automatically generate the the whole service, except for the implementation specific details for an RPC call.
- Make serde_xdr a stand-alone crate
- Serialization of Option<> types as discriminant unions
- Prevent consumption of bytes in too small of packets
- OkCupid specific complilation flag for non-standard tweaks
- PoC client implementation
- Improve Error messages
- Implement more XDR rejection responses
- Test Suite
Please file a github issue if you experience any problems