chomp1

namechomp1
created_at2022-05-07 14:38:32.295836
updated_at2023-05-07 11:17:37.147352
downloads10449
descriptionA fast monadic-style parser combinator designed to work on stable Rust.
homepagehttp://github.com/jedisct1/rust-chomp1
repositoryhttp://github.com/jedisct1/rust-chomp1
max_upload_size
id582146
Frank Denis

documentation

https://docs.rs/chomp1

readme

# Chomp [![Gitter](https://badges.gitter.im/m4rw3r/chomp.svg)](https://gitter.im/m4rw3r/chomp?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) [![Build Status](https://travis-ci.org/m4rw3r/chomp.svg?branch=master)](https://travis-ci.org/m4rw3r/chomp) [![Coverage Status](https://coveralls.io/repos/m4rw3r/chomp/badge.svg?branch=master&service=github)](https://coveralls.io/github/m4rw3r/chomp?branch=master) [![Crates.io](https://img.shields.io/crates/v/chomp.svg)](https://crates.io/crates/chomp) [![Documentation](https://img.shields.io/badge/rustdoc-documentation-blue.svg)](http://m4rw3r.github.io/chomp) Chomp is a fast monadic-style parser combinator library designed to work on stable Rust. It was written as the culmination of the experiments detailed in these blog posts: * [Part 1](http://m4rw3r.github.io/parser-combinator-experiments-rust) * [Part 2](http://m4rw3r.github.io/parser-combinator-experiments-errors) * [Part 3](http://m4rw3r.github.io/parser-combinator-experiments-part-3) * [Chomp 0.1 Announcement](http://m4rw3r.github.io/parser-combinators-road-chomp-0-1) For its current capabilities, you will find that Chomp performs consistently as well, if not better, than optimized C parsers, while being vastly more expressive. For an example that builds a performant HTTP parser out of smaller parsers, see [http_parser.rs](examples/http_parser.rs). ## Installation Add the following line to the dependencies section of your `Cargo.toml`: ```toml [dependencies] chomp = "0.3.1" ``` ## Usage Parsers are functions from a slice over an input type `Input` to a `ParseResult`, which may be thought of as either a success resulting in type `T`, an error of type `E`, or a partially completed result which may still consume more input of type `I`. The input type is almost never manually manipulated. Rather, one uses parsers from Chomp by invoking the `parse!` macro. This macro was designed intentionally to be as close as possible to Haskell's `do`-syntax or F#'s "computation expressions", which are used to sequence monadic computations. At a very high level, usage of this macro allows one to declaratively: * Sequence parsers, while short circuiting the rest of the parser if any step fails. * Bind previous successful results to be used later in the computation. * Return a composite datastructure using the previous results at the end of the computation. In other words, just as a normal Rust function usually looks something like this: ```rust fn f() -> (u8, u8, u8) { let a = read_digit(); let b = read_digit(); launch_missiles(); return (a, b, a + b); } ``` A Chomp parser with a similar structure looks like this: ```rust fn f(i: I) -> SimpleResult { parse!{i; let a = digit(); let b = digit(); string(b"missiles"); ret (a, b, a + b) } } ``` And to implement `read_digit` we can utilize the `map` function to manipulate any success value while preserving any error or incomplete state: ```rust // Standard rust, no error handling: fn read_digit() -> u8 { let mut s = String::new(); std::io::stdin().read_line(&mut s).unwrap(); s.trim().parse().unwrap() } // Chomp, error handling built in, and we make sure we only get a number: fn read_digit(i: I) -> SimpleResult { satisfy(i, |c| b'0' <= c && c <= b'9').map(|c| c - b'0') } ``` For more documentation, see the rust-doc output. ## Example ```rust #[macro_use] extern crate chomp1; use chomp1::prelude::*; #[derive(Debug, Eq, PartialEq)] struct Name { first: B, last: B, } fn name(i: I) -> SimpleResult> { parse!{i; let first = take_while1(|c| c != b' '); token(b' '); // skipping this char let last = take_while1(|c| c != b'\n'); ret Name{ first: first, last: last, } } } assert_eq!(parse_only(name, "Martin Wernstål\n".as_bytes()), Ok(Name{ first: &b"Martin"[..], last: "Wernstål".as_bytes() })); ``` ## License Licensed under either of * Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0) * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) at your option. ### Contribution Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions. ## Contact File an issue [here](https://github.com/m4rw3r/chomp/issues/new) on Github or visit [gitter.im/m4rw3r/chomp](https://gitter.im/m4rw3r/chomp).
Commit count: 0

cargo fmt