Skip to main content

Crate marser

Crate marser 

Source
Expand description

§marser

marser is a parser-combinator library for writing PEG-style grammars in Rust with a focus on useful errors, error recovery and good performance.

It supports:

  • Zero-copy parsing for faster parsers
  • Multiple input formats - use &str and &[u8] / &[T] or implement the Input trait yourself.
  • Packrat-style caching - just wrap your parsers in .memoized() to cache results at each position.
  • Simple debugging of your parsers using a custom TUI

§Quickstart

To add this library to your Rust project run:

cargo add marser

This library has a couple of optional features. You can find them below.

§Example

This example parses dice notation like 2d6 into a struct:

use marser::capture;
use marser::matcher::one_or_more;
use marser::parser::Parser;

// the struct we want to parse into
struct Roll {
    count: u32,
    sides: u32,
}

// A parser that can parse a number
fn number<'src>() -> impl Parser<'src, &'src str, Output = u32> + Clone {
    // capture defines a parser. It consists of a matcher (the part before `=>`) 
    // and a Rust expression that builds the output value (the part after `=>`).
    capture!(
        bind_slice!( // bind_slice! stores the matched part of the input inside a variable
            one_or_more('0'..='9'), // matches any sequence of digits
            number_slice as &'src str // the matched digits are available as `number_slice` of type `&'src str`
        )
        => // we can then define how to build the output value from the bound variables
            number_slice // we use the captured slice of digits
                .parse() // and parse it into a u32
                .expect("matched only digits")
    )
}

// A parser that can parse a roll like `2d6`
fn roll<'src>() -> impl Parser<'src, &'src str, Output = Roll> + Clone {
    // we again define a parser with capture!, this time for the whole roll
    capture!(
        ( // we define a sequence by putting multiple matchers in a tuple
          // they are matched one after another
            bind!(number(), count), // first we expect a number. We use bind! to store its value in `count`
            'd', // then we expect the literal character 'd'
            bind!(number(), sides) // then we expect another number, which we store in `sides`
        )
        => // finally we define how to build the output value from the bound variables
            Roll { count, sides }
    )
}

fn main() {
    // we can then use this parser we defined to parse a string
    let (roll, _errors) = roll().parse_str("2d6").unwrap();
    assert_eq!(roll, Roll { count: 2, sides: 6 });
}

Runnable examples live under examples/ (see also below).

§Learn more

§Cargo features

FeatureWhen you need it
(default)Core library only.
annotate-snippetsEnables rendering of error messages using the annotate-snippets crate
parser-traceExperimental: record parser traces to replay them in the trace viewer TUI. See the tracing guide and marser-trace-viewer/.

Compatibility: Releases follow semver for the documented public API. Everyday composition (capture!, matchers, errors) is intended to stay stable across minors; tracing and trace crates may evolve faster. Macro expansion details are not a stability guarantee — please use macros as APIs, not generated internals.

§Requirements

  • Rust 1.88 or later

§Examples in this repository

Examples need the annotate-snippets feature for rendering of errors

ExampleWhat it shows
examples/json/A JSON parser with error recovery and custom error messages.
examples/mini_language.rsSmall language: statements, operator precedence, functions etc. with error recovery and custom error messages.

Run JSON from a git clone:

cargo run --example json --features annotate-snippets -- tests/data/json1.json

§Error output sample

Input:

{
    "foo": 123,
    "bar": [1, ,2 ,3
}

Example diagnostic, rendered using annotate-snippets:

Example parse error for invalid JSON Screenshot

This parser can also still produce a recovered output:

{
    "foo": 123,
    "bar": [
        1,
        2,
        3
    ]
}

§Early release

Early release: marser is my first published Rust library. Feedback on the API, error messages, and docs is welcome — open an issue

§License

This project is licensed under the MIT License.

§AI assistance

Parts of this repository were drafted or expanded with AI tools (guide, library docs, tests, macros, trace crates, examples, and parts of this README). The maintainer reviewed this material. If you spot a mistake, please open an issue.

Modules§

error
Parse errors and diagnostics.
guideembed-guide
Book-style guide to marser for newcomers and for evaluating fit.
input
Input abstractions for parsers and matchers.
label
Attach a displayable label to a crate::matcher::Matcher or crate::parser::Parser for richer errors.
matcher
Matchers: grammar fragments used inside crate::parser::capture::Capture (via crate::capture) and related runners.
one_of
Ordered choice: try each alternative until one succeeds.
parser
Parsers: typed values produced from input.
trace
Tracing helpers and (with the parser-trace feature) re-exports from marser_trace_schema.

Macros§

capture
Build a parser from grammar + result expressions (via Capture, returned as impl Parser to limit type size).

Enums§

ParseWithTraceToFileErrorparser-trace
Error returned by parse_with_trace_to_file.

Functions§

parse
Parse all of src with the same driver as Parser::parse_str / Parser::parse_whole_input.
parse_with_traceparser-trace
Parse src and return the trace session alongside the normal parse result.
parse_with_trace_sessionparser-trace
Like parse_with_trace, but reuses an existing TraceSession.
parse_with_trace_to_fileparser-trace
Parse src, write the trace to trace_path, and return the normal parse result.