charset-norm 4.1.0

Universal character encoding detector: a Rust implementation of charset_normalizer
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75

# charset-norm

Universal character encoding detector for Rust: a Rust implementation of
[charset_normalizer](https://github.com/jawah/charset_normalizer).

It decodes a payload with every supported code page, measures how noisy each
result looks (*chaos*) and how well it matches known languages (*coherence*),
and ranks the plausible encodings. Decoding reproduces CPython's codecs byte
for byte (98 code pages, including the CJK and ISO-2022 families), so results
agree with the Python package.

## Usage

```toml
[dependencies]
charset-norm = "4.1"
```

```rust
let payload = std::fs::read("subtitles.srt")?;
let results = charset_norm::from_bytes(&payload);

match results.best() {
    Some(best) => {
        println!("{} ({})", best.encoding(), best.language());
        let text = best.decoded()?;
        let utf8 = best.output("utf_8")?;
    }
    None => println!("probably binary"),
}
```

Detection can be tuned and observed:

```rust
use charset_norm::{from_bytes_with, DetectionOptions, NoLogger};

let options = DetectionOptions {
    cp_isolation: vec!["cp1252".into(), "cp1251".into()],
    ..DetectionOptions::default()
};
let results = from_bytes_with(&payload, &options, &NoLogger);
```

The building blocks are public too: `codecs` (CPython-compatible decoders and
encoders), `encoding` (names, BOMs, declared charsets), `mess`, `coherence`
and `unicode`.

## Features

- `log`: forward detection diagnostics to the [`log`](https://docs.rs/log)
  crate through `charset_norm::log::LogCrate`.
- `hotpath`: instrument the detector's stages (decoding, chunk sampling,
  mess and coherence scoring, ...) with [hotpath](https://github.com/pawurb/hotpath-rs)
  probes. They report into the profile of any binary annotated with
  `#[hotpath::main]`, and do nothing otherwise. `hotpath-alloc` reports
  allocations instead of timings. Without these features the probes compile
  to nothing.

## Profiling

The `profile` example runs detection over a directory of files and prints a
hotpath report:

```sh
git clone https://github.com/Ousret/char-dataset
cargo run --release -p charset-norm --example profile --features hotpath -- char-dataset
# Allocations instead of timings:
cargo run --release -p charset-norm --example profile --features hotpath-alloc -- char-dataset
```

## License

MIT. Based on [charset_normalizer](https://github.com/jawah/charset_normalizer)
by Ahmed TAHRI.