Version 2

.gitignore

@@ -1,9 +1,2 @@
 /target
-Cargo.lock
-benches/alternatives.html
-mail.txt
-.vscode/settings.json
-mail3.txt
-mail2.txt
-# This is a file for testing 491179 emails. Too big for git
-tests/local_emails.rs
+/Cargo.lock

Cargo.toml

@@ -1,4 +1,11 @@
-[workspace]
-members = [
-    "email-parser",
-]
+[package]
+name = "email-parser2"
+authors = ["Mubelotix <[email protected]>"]
+version = "0.1.0"
+edition = "2021"
+
+[dependencies]
+faster-pest = { path="../../pest-based-parser/faster-pest" }
+
+[dev-dependencies]
+email-parser = { path="../email-parser" }

README.md

@@ -1,53 +1,17 @@
 # email-parser
 
-The fastest and lightest email parsing Rust library!\
-This library has no dependency by default (and only a small optional one).
+The fastest and lightest email parsing Rust library!
 
-## Goal
+## History
 
-The goal of this library is to be fully compliant with RFC 5322. However, this library does not intend to support the obsolete syntax because it has been obsolete for 12 years, and it would slow down everything.\
-This library supports MIME and will support PGP in the future.
+Started in mid-2020, this library was originally designed to be a handmade, zero-dependency email parsing library.
+The performance of this library was unrivalled.
+However, the maintainance cost was too high.
 
-## Example
+I started wondering if I could use Rust macros to generate the parsing code.
+I liked [pest](https://pest.rs/) but it had terrible performance.
+Using the knowledge I got writing the first email parser, I wrote [a better code generator](https://github.com/Mubelotix/faster-pest) for pest grammars.
 
-```rust
-let email = Email::parse(
-    b"\
-    From: Mubelotix <[email protected]>\r\n\
-    Subject:Example Email\r\n\
-    To: Someone <[email protected]>\r\n\
-    Message-id: <[email protected]>\r\n\
-    Date: 5 May 2003 18:58:34 +0000\r\n\
-    \r\n\
-    Hey!\r\n",
-)
-.unwrap();
-
-assert_eq!(email.subject.unwrap(), "Example Email");
-assert_eq!(email.sender.name.unwrap(), vec!["Mubelotix"]);
-assert_eq!(email.sender.address.local_part, "mubelotix");
-assert_eq!(email.sender.address.domain, "mubelotix.dev");
-```
-
-## Pay for what you use
-
-Mails can be elaborated. No matter what you are building, you are certainly not using all of its features.\
-So why would you pay the parsing cost of header fields you are not using? This library allows you to enable headers you need so that other header values will be parsed as an unstructured header, which is much faster.\
-By disabling all header value parsing, this library can parse an entire mail twice faster! But don't worry if you need everything enabled; this library is blazing fast anyway!
-
-## Zero-Copy (almost)
-
-This library tries to avoid usage of owned `String`s as much as possible and is using `Cow<str>` instead.\
-Thanks to this method, around 90% of the strings are references.
-
-## Benchmarks
-
-This chart shows the time took to parse a single email.
-
-![Benchmark](https://cdn.discordapp.com/attachments/694923348844609597/789162705494868020/unknown.png)
-
-Run these benchmarks by yourself with `rustup run nightly cargo bench` and `rustup run nightly cargo bench --no-default-features`.\
-Tests require a `mail.txt` file containing a raw mail next to the `Cargo.toml`.\
-Some libraries suffer from huge performance variations depending on the content of the mail, so this library is not **always** the fastest.
-
-License: MIT
+Then, I made the current version of this library, whose code is almost **entirely automatically generated**.
+The generated code is so overly optimized, it has beaten my older handmade parser.
+This is the **fastest email parser** among all those I have tested.

benches/alternatives.rs

@@ -0,0 +1,17 @@
+#![feature(test)]
+
+extern crate test;
+use test::Bencher;
+
+const MAIL: &[u8] = include_bytes!("../mail.txt");
+const MAIL2: &str = include_str!("../mail.txt");
+
+#[bench]
+fn email_parser2(b: &mut Bencher) {
+    b.iter(|| email_parser2::Email::parse(MAIL2));
+}
+
+#[bench]
+fn email_parser(b: &mut Bencher) {
+    b.iter(|| email_parser::email::Email::parse(MAIL));
+}