https://github.com/cloudflare/lol-html

Low output latency streaming HTML parser/rewriter with CSS selector-based API
https://github.com/cloudflare/lol-html

css-selectors html parser rewriting rust stream streaming

Last synced: about 1 month ago
JSON representation

Low output latency streaming HTML parser/rewriter with CSS selector-based API

• Host: GitHub
• URL: https://github.com/cloudflare/lol-html
• Owner: cloudflare
• License: bsd-3-clause
• Created: 2019-09-09T02:20:32.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2024-09-25T15:04:47.000Z (about 2 months ago)
• Last Synced: 2024-10-02T01:41:35.633Z (about 1 month ago)
• Topics: css-selectors, html, parser, rewriting, rust, stream, streaming
• Language: Rust
• Homepage: https://crates.io/crates/lol-html
• Size: 2.62 MB
• Stars: 1,457
• Watchers: 28
• Forks: 80
• Open Issues: 47
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

• awesome-list - lol-html - based API | cloudflare | 651 | (HTML)

README

        
# LOL HTML



    

        

    



***L**ow **O**utput **L**atency 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](https://blog.cloudflare.com/html-parsing-2/).

The crate serves as a back-end for the HTML rewriting functionality of

[Cloudflare Workers](https://www.cloudflare.com/en-gb/products/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](https://github.com/cloudflare/lol-html/tree/master/c-api)

- [Lua](https://github.com/jdesgats/lua-lolhtml)

- [Go](https://github.com/coolspring8/go-lolhtml) (unofficial, not coming from Cloudflare)

- [Ruby](https://github.com/gjtorikian/selma) (unofficial, not coming from Cloudflare)

## Example

Rewrite insecure hyperlinks:

```rust

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

fn main() -> Result<(), Box> {

    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"
")?;

    rewriter.write(b"
")?;

    rewriter.end()?;


    assert_eq!(

        String::from_utf8(output)?,

        r#"
"#

    );

    Ok(())

}

```


## License

BSD licensed. See the [LICENSE](LICENSE) file for details.