14 releases (7 stable)

2.0.0 Sep 25, 2024
1.2.1 Mar 11, 2024
1.2.0 Sep 13, 2023
1.1.1 Jul 31, 2023
0.1.0 Nov 26, 2019

#232 in Parser implementations

Download history 4668/week @ 2024-07-28 4078/week @ 2024-08-04 4547/week @ 2024-08-11 3669/week @ 2024-08-18 3729/week @ 2024-08-25 4282/week @ 2024-09-01 4201/week @ 2024-09-08 3929/week @ 2024-09-15 4526/week @ 2024-09-22 6273/week @ 2024-09-29 6096/week @ 2024-10-06 5716/week @ 2024-10-13 6527/week @ 2024-10-20 6955/week @ 2024-10-27 7775/week @ 2024-11-03 7051/week @ 2024-11-10

28,702 downloads per month
Used in 60 crates (39 directly)

BSD-3-Clause

550KB
12K SLoC

LOL HTML

The logo is generated from https://openmoji.org/data/color/svg/1F602.svg by Emily Jäger which is licensed under CC BY-SA 4.0 (https://creativecommons.org/licenses/by-sa/4.0/)

Low Output Latency streaming HTML rewriter/parser with CSS-selector based API.

It is designed to modify HTML on the fly with minimal buffering. It can quickly handle very large documents, and operate in environments with limited memory resources. More details can be found in the blog post.

The crate serves as a back-end for the HTML rewriting functionality of Cloudflare Workers, but can be used as a standalone library with a convenient API for a wide variety of HTML rewriting/analysis tasks.

Documentation

https://docs.rs/lol_html/

Bindings for other programming languages

  • C
  • Lua
  • Go (unofficial, not coming from Cloudflare)
  • Ruby (unofficial, not coming from Cloudflare)

Example

Rewrite insecure hyperlinks:

use lol_html::{element, HtmlRewriter, Settings};

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mut output = vec![];

    let mut rewriter = HtmlRewriter::new(
        Settings {
            element_content_handlers: vec![
                element!("a[href]", |el| {
                    let href = el
                        .get_attribute("href")
                        .expect("href was required")
                        .replace("http:", "https:");

                    el.set_attribute("href", &href)?;

                    Ok(())
                })
            ],
            ..Settings::new()
        },
        |c: &[u8]| output.extend_from_slice(c)
    );

    rewriter.write(b"<div><a href=")?;
    rewriter.write(b"http://example.com>")?;
    rewriter.write(b"</a></div>")?;
    rewriter.end()?;

    assert_eq!(
        String::from_utf8(output)?,
        r#"<div><a href="https://example.com"></a></div>"#
    );
    Ok(())
}

License

BSD licensed. See the LICENSE file for details.

Dependencies

~8.5MB
~216K SLoC