Skip to content

Rust Engine API Reference

The jsonette core library documentation is generated directly from our Rust source code docstrings.


🔗 Crate Documentation

The generated API reference lists public modules, parser structs, diagnostics translation helpers, and formatters:

Open Rust API Reference ↗


📦 Key API Components

The rustdocs cover:

  • Parser: Handles parsing JSON text and generating tolerant syntax trees.
  • Formatter: Manages pretty printing, indentation, and minification.
  • QueryEngine: Evaluates RFC 9535 JSONPath expressions.

🌐 FFI Binding Compatibility Matrix

The core Rust engine is wrapped with UniFFI. Compatibility is verified on every PR commit using compiled and executed smoke-test programs:

Language Bindings Engine Verification Method Status CI Status
Swift UniFFI (Native) Compiled & Executed via swiftc Supported CI Status
Python UniFFI (Native) Executed via python3 Supported CI Status
C / C++ UniFFI (Header) Compiled & Executed via clang Supported CI Status
Kotlin UniFFI (Native) Generated via uniffi-bindgen Supported CI Status
Java UniFFI (JVM/JNA) Shared via Kotlin JNA Bindings Supported CI Status
JS / TS WebAssembly Planned (Milestone 4) Roadmap Planned

Detailed instructions on generating bindings, compilation flags, and linking are available in the UniFFI Swift Bridge Reference.