README.md

serde_rustler

Serde Serializer and Deserializer for Rustler NIFs.

Contents

This repo contains the following:

• serde_rustler: Rust crate providing the Serializer and Deserializer; meant to be used within your NIF libraries.
• serde_rustler_tests: NIF written for testing and benchmarking serde_rustler
  • see the repo README for installation instructions, a simple example of usage, and data model conversion table.
  • check out the tests in readme_test.exs for the README example or serde_rustler_tests_test.exs to see the Elixir-end of the types and tests, or serde_rustler_tests/src/test.rs and serde_rustler_tests/src/types.rs to see the NIF tests and Rust native types.
  • see json.rs for the implementation of the JSON encoding/decoding benchmark functions, or benchmarks.exs for the benchmarks themselves, or just encode.md or decode.md to skip to the results.