README2.md

Chumsky

Chumsky is a parser combinator library for Rust that makes writing expressive, high-performance parsers easy.

Although chumsky is designed primarily for user-fancing parsers such as compilers, chumsky is just as much at home parsing binary protocols at the networking layer, configuration files, or any other form of complex input validation that you may need. It also has no_std support, making it suitable for embedded environments.

Features

• 🪄 Expressive combinators that make writing your parser a joy
• 🎛️ Fully generic across input, token, output, span, and error types
• 📑 Zero-copy parsing minimises allocation by having outputs hold references/slices of the input
• 🚦 Flexible error recovery strategies out of the box
• 🚀 Internal optimiser leverages the power of GATs to optimise your parser for you
• 📖 Text-oriented parsers for text inputs (i.e: &[u8] and &str)
• 👁️‍🗨️ Context-free grammars are fully supported, with support for context-sensitivity
• 🔄 Left recursion and memoization have opt-in support
• 🪺 Nested inputs such as token trees are fully supported both as inputs and outputs
• 🏷️ Pattern labelling for dynamic, user-friendly error messages
• 🗃️ Caching allows parsers to be created once and reused many times
• ↔️ Pratt parsing support for unary and binary operators
• 🪛 no_std support, allowing chumsky to run in embedded environments

Note: Error diagnostic rendering is performed by Ariadne

Example

See examples/brainfuck.rs for a full Brainfuck interpreter (cargo run --example brainfuck -- examples/sample.bf).

use chumsky::prelude::*;

/// An AST (Abstract Syntax Tree) for Brainfuck instructions
#[derive(Clone)]
enum Instr {
    Left, Right,
    Incr, Decr,
    Read, Write,
    Loop(Vec<Self>), // In Brainfuck, `[...]` loops contain sub-blocks of instructions
}

/// A function that returns an instance of our Brainfuck parser
fn parser<'a>() -> impl Parser<'a, &'a str, Vec<Instr>> {
	// Brainfuck syntax is recursive: each block can contain many sub-blocks (via `[...]` loops)
    recursive(|bf| choice((
		// All of the basic instructions are just single characters
        just('<').to(Instr::Left),
        just('>').to(Instr::Right),
        just('+').to(Instr::Incr),
        just('-').to(Instr::Decr),
        just(',').to(Instr::Read),
        just('.').to(Instr::Write),
		// Loops are strings of Brainfuck instructions, delimited by square brackets
        bf.delimited_by(just('['), just(']')).map(Instr::Loop),
    ))
		// Brainfuck instructions are sequential, so parse as many as we need
        .repeated()
        .collect())
}

// Parse some Brainfuck with our parser
parser().parse("--[>--->->->++>-<<<<<-------]>--.>---------.>--..+++.>----.>+++++++++.<<.+++.------.<-.>>+.")

See examples/ for more example uses of chumsky, including a toy Rust-like interpreter.

Other examples include:

• A JSON parser (cargo run --example json -- examples/sample.json)
• An interpreter for a simple Rust-y language (cargo run --example nano_rust -- examples/sample.nrs)

Tutorial

Chumsky has a tutorial that teaches you how to write a parser and interpreter for a simple dynamic language with unary and binary operators, operator precedence, functions, let declarations, and calls.

Cargo Features

Chumsky contains several optional features that extend the crate's functionality.

• pratt: enables the pratt parsing combinator

• regex: enables the regex combinator

• serde: enables serde (de)serialization support for several types

• either: implements Parser for either::Either, allowing dynamic configuration of parsers at runtime

• extension: enables the extension API, allowing you to write your own first-class combinators that integrate with and extend chumsky

• memoization: enables memoization features

• stacker (enabled by default): avoid stack overflows by spilling stack data to the heap via the stacker crate

• unstable: enables experimental chumsky features

• std (enabled by default): support for standard library features

• nightly: enable support for features only supported by the nightly Rust compiler

What is a parser combinator?

Parser combinators are a technique for implementing parsers by defining them in terms of other parsers. The resulting parsers use a recursive descent strategy to transform a stream of tokens into an output. Using parser combinators to define parsers is roughly analogous to using Rust's Iterator trait to define iterative algorithms: the type-driven API of Iterator makes it more difficult to make mistakes and easier to encode complicated iteration logic than if one were to write the same code by hand. The same is true of parser combinators.

Why use parser combinators?

Writing parsers with good error recovery is conceptually difficult and time-consuming. It requires understanding the intricacies of the recursive descent algorithm, and then implementing recovery strategies on top of it. If you're developing a programming language, you'll almost certainly change your mind about syntax in the process, leading to some slow and painful parser refactoring. Parser combinators solve both problems by providing an ergonomic API that allows for rapidly iterating upon a syntax.

Parser combinators are also a great fit for domain-specific languages for which an existing parser does not exist. Writing a reliable, fault-tolerant parser for such situations can go from being a multi-day task to a half-hour task with the help of a decent parser combinator library.

Classification

Chumsky's parsers are recursive descent parsers and are capable of parsing parsing expression grammars (PEGs), which includes all known context-free languages. It is theoretically possible to extend Chumsky further to accept limited context-sensitive grammars too, although this is rarely required.

Error Recovery

Chumsky has support for error recovery, meaning that it can encounter a syntax error, report the error, and then attempt to recover itself into a state in which it can continue parsing so that multiple errors can be produced at once and a partial AST can still be generated from the input for future compilation stages to consume.

However, there is no silver bullet strategy for error recovery. By definition, if the input to a parser is invalid then the parser can only make educated guesses as to the meaning of the input. Different recovery strategies will work better for different languages, and for different patterns within those languages.

Chumsky provides a variety of recovery strategies (each implementing the Strategy trait), but it's important to understand that all of

• which you apply
• where you apply them
• what order you apply them

will greatly affect the quality of the errors that Chumsky is able to produce, along with the extent to which it is able to recover a useful AST. Where possible, you should attempt more 'specific' recovery strategies first rather than those that mindlessly skip large swathes of the input.

It is recommended that you experiment with applying different strategies in different situations and at different levels of the parser to find a configuration that you are happy with. If none of the provided error recovery strategies cover the specific pattern you wish to catch, you can even create your own by digging into Chumsky's internals and implementing your own strategies! If you come up with a useful strategy, feel free to open a PR against the main repository!

Performance

Chumsky focuses on high-quality errors and ergonomics over performance. That said, it's important that Chumsky can keep up with the rest of your compiler! Unfortunately, it's extremely difficult to come up with sensible benchmarks given that exactly how Chumsky performs depends entirely on what you are parsing, how you structure your parser, which patterns the parser attempts to match first, how complex your error type is, what is involved in constructing your AST, etc. All that said, here are some numbers from the JSON benchmark included in the repository running on my Ryzen 7 3700x.

test chumsky ... bench:   4,782,390 ns/iter (+/- 997,208)
test pom     ... bench:  12,793,490 ns/iter (+/- 1,954,583)

I've included results from pom, another parser combinator crate with a similar design, as a point of reference. The sample file being parsed is broadly representative of typical JSON data and has 3,018 lines. This translates to a little over 630,000 lines of JSON per second.

Clearly, this is a little slower than a well-optimised hand-written parser: but that's okay! Chumsky's goal is to be fast enough. If you've written enough code in your language that parsing performance even starts to be a problem, you've already committed enough time and resources to your language that hand-writing a parser is the best choice going!

Planned Features

• An optimised 'happy path' parser mode that skips error recovery & error generation
• An even faster 'validation' parser mode, guaranteed to not allocate, that doesn't generate outputs but just verifies the validity of an input

Philosophy

Chumsky should:

• Be easy to use, even if you don't understand exactly what the parser is doing under the hood
• Be type-driven, pushing users away from anti-patterns at compile-time
• Be a mature, 'batteries-included' solution for context-free parsing by default. If you need to implement either Parser or Strategy by hand, that's a problem that needs fixing
• Be 'fast enough', but no faster (i.e: when there is a tradeoff between error quality and performance, Chumsky will always take the former option)
• Be modular and extensible, allowing users to implement their own parsers, recovery strategies, error types, spans, and be generic over both input tokens and the output AST

Notes

My apologies to Noam for choosing such an absurd name.

License

Chumsky is licensed under the MIT license (see LICENSE in the main repository).