Welcome to the rill-json Wiki!

Welcome to the official wiki for rill-json, a fast, 100% safe, and RFC 8259-compliant JSON parser and serializer, built from scratch in Rust.

The main README provides a quick-start guide. This wiki is for more in-depth documentation for users and contributors.

Core Philosophy

rill-json is built on three key principles:

1. Safety: 100% safe Rust. The library uses #![forbid(unsafe_code)] to guarantee this.
2. Performance: Designed for high-throughput scenarios. It uses advanced, safe techniques like byte-based lookup tables (LUTs) and memchr for SIMD-accelerated string parsing.
3. Low Memory: The streaming parser is an Iterator [cite: 2], allowing you to parse gigabyte-sized files with a constant, tiny memory footprint.

Table of Contents

For Users

• Guide: Using the Streaming Parser
  • Learn how to use the Iterator-based parser for common, real-world tasks.
• Guide: Serializing Data (Stringify)
  • A guide on using JsonValue to create your own JSON strings.
• API Reference
  • A detailed breakdown of all public items: parse_streaming, ParserEvent, JsonValue, JsonNumber, and ParseError.

For Contributors

• Architecture Overview
  • A deep dive into the parser's design, performance optimizations (LUT & memchr), and module structure.
• How to Contribute
  • Guidelines for submitting bug reports, feature requests, and pull requests.