README.md
1# combine
2[](https://travis-ci.org/Marwes/combine)
3[](https://docs.rs/combine/^3)
4[](https://docs.rs/combine)
5[](https://gitter.im/Marwes/combine?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
6
7An implementation of parser combinators for Rust, inspired by the Haskell library [Parsec](https://hackage.haskell.org/package/parsec). As in Parsec the parsers are [LL(1)](https://en.wikipedia.org/wiki/LL_parser) by default but they can opt-in to arbitrary lookahead using the [attempt combinator](https://docs.rs/combine/*/combine/fn.attempt.html).
8
9## Example
10
11```rust
12extern crate combine;
13use combine::{many1, Parser, sep_by};
14use combine::parser::char::{letter, space};
15
16// Construct a parser that parses *many* (and at least *1) *letter*s
17let word = many1(letter());
18
19// Construct a parser that parses many *word*s where each word is *separated by* a (white)*space*
20let mut parser = sep_by(word, space())
21 // Combine can collect into any type implementing `Default + Extend` so we need to assist rustc
22 // by telling it that `sep_by` should collect into a `Vec` and `many1` should collect to a `String`
23 .map(|mut words: Vec<String>| words.pop());
24let result = parser.parse("Pick up that word!");
25// `parse` returns `Result` where `Ok` contains a tuple of the parsers output and any remaining input.
26assert_eq!(result, Ok((Some("word".to_string()), "!")));
27```
28
29Larger examples can be found in the [examples][], [tests][] and [benches][] folders.
30
31[examples]:https://github.com/Marwes/combine/tree/master/examples
32[tests]:https://github.com/Marwes/combine/tree/master/tests
33[benches]:https://github.com/Marwes/combine/tree/master/benches
34
35## Tutorial
36
37A tutorial as well as explanations on what goes on inside combine can be found in [the wiki](https://github.com/Marwes/combine/wiki).
38
39### Translation
40
41[Japanese](https://github.com/sadnessOjisan/combine-ja)
42
43## Links
44
45[Documentation and examples](https://docs.rs/crate/combine)
46
47[crates.io](https://crates.io/crates/combine)
48
49## Features
50
51* __Parse arbitrary streams__ - Combine can parse anything from `&[u8]` and `&str` to iterators and `Read` instances. If none of the builtin streams fit your use case you can even implement a couple traits your self to create your own custom [stream](https://docs.rs/combine/3.*/combine/stream/index.html)!
52
53* __zero-copy parsing__ - When parsing in memory data, combine can parse without copying. See the [range module](https://docs.rs/combine/3.*/combine/parser/range/index.html) for parsers specialized for zero-copy parsing.
54
55* __partial parsing__ - Combine parsers can be stopped at any point during parsing and later be resumed without losing any progress. This makes it possible to start parsing partial data coming from an io device such as a socket without worrying about if enough data is present to complete the parse. If more data is needed the parser will stop and may be resumed at the same point once more data is available. See the [async example](https://github.com/Marwes/combine/blob/master/examples/async.rs) for an example and [this post](https://marwes.github.io/2018/02/08/combine-3.html) for an introduction.
56
57## About
58
59A parser combinator is, broadly speaking, a function which takes several parsers as arguments and returns a new parser, created by combining those parsers. For instance, the [many](https://docs.rs/combine/*/combine/fn.many.html) parser takes one parser, `p`, as input and returns a new parser which applies `p` zero or more times. Thanks to the modularity that parser combinators gives it is possible to define parsers for a wide range of tasks without needing to implement the low level plumbing while still having the full power of Rust when you need it.
60
61The library adheres to [semantic versioning](https://semver.org/).
62
63If you end up trying it I welcome any feedback from your experience with it. I am usually reachable within a day by opening an issue, sending an email or posting a message on Gitter.
64
65## FAQ
66
67### Why does my errors contain inscrutable positions?
68
69Since `combine` aims to crate parsers with little to no overhead, streams over `&str` and `&[T]` do not carry any extra position information, but instead, they only rely on comparing the pointer of the buffer to check which `Stream` is further ahead than another `Stream`. To retrieve a better position, either call `translate_position` on the `PointerOffset` which represents the position or wrap your stream with `State`.
70
71### How does it compare to nom?
72
73https://github.com/Marwes/combine/issues/73 contains discussion and links to comparisons to [nom](https://github.com/Geal/nom).
74
75## Parsers written in combine
76
77### Formats and protocols
78
79* GraphQL https://github.com/graphql-rust/graphql-parser (Uses a custom tokenizer as input)
80* DiffX https://github.com/brennie/diffx-rs
81* Redis https://github.com/mitsuhiko/redis-rs/pull/141 (Uses partial parsing)
82* Toml https://github.com/ordian/toml_edit
83* Maker Interchange Format https://github.com/aidanhs/frametool (Uses combine as a lexer)
84* Javascript https://github.com/freemasen/ress
85* JPEG Metadata https://github.com/vadixidav/exifsd
86
87### Miscellaneous
88
89* Template language https://github.com/tailhook/trimmer
90* Code exercises https://github.com/dgel/adventOfCode2017
91* Programming language
92 * https://github.com/MaikKlein/spire-lang
93 * https://github.com/vadixidav/typeflow/tree/master/lang
94* Query parser (+ more) https://github.com/mozilla/mentat
95* Query parser https://github.com/tantivy-search/tantivy
96
97## Extra
98
99There is an additional crate which has parsers to lex and parse programming languages in [combine-language](https://github.com/Marwes/combine-language).
100
101You can find older versions of combine (parser-combinators) [here](https://crates.io/crates/parser-combinators).
102
103## Contributing
104
105Current master is the 3.0.0 branch. If you want to submit a fix or feature to the 2.x version of combine then
106do so to the 2.x branch or submit the PR to master and request that it be backported.
107
108The easiest way to contribute is to just open an issue about any problems you encounter using combine but if you are interested in adding something to the library here is a list of some of the easier things to work on to get started.
109
110* __Add additional parsers__ If you have a suggestion for another parser just open an issue or a PR with an implementation.
111* __Add additional examples__ More examples for using combine will always be useful!
112* __Add and improve the docs__ Not the fanciest of work but one cannot overstate the importance of good documentation.
113
114
){kind=link}
){kind=link}
){kind=link}