url-sanitize-core 2.0.2

Pure-Rust library for removing tracking parameters and unwrapping tracking redirects.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

# url-sanitize-core

Pure-Rust implementation for removing tracking parameters and unwrapping
tracking redirects according to the
[url-sanitize behavioral spec](https://github.com/antonio-orionus/url-sanitize/blob/main/docs/spec.md).

Engine only — no embedded catalog. For a ready-to-use binary with the merged
ClearURLs, AdGuard, Brave, and Firefox catalog baked in, see the
[`url-sanitize`](https://crates.io/crates/url-sanitize) crate.

```rust
use url_sanitize_core::{Catalog, SanitizerOptions};

let json = std::fs::read_to_string("catalog/catalog.json")?;
let catalog = Catalog::from_json(&json)?;
let sanitizer = catalog.compile(SanitizerOptions::default());
let result = sanitizer.sanitize("https://example.com/?utm_source=x");
println!("{}", serde_json::to_string(&result)?);
```

Conformance with the TypeScript engine is verified by the shared corpus in
[`conformance/`](https://github.com/antonio-orionus/url-sanitize/tree/main/conformance).