compact-enc-det 0.1.0

Rust bindings for Compact Encoding Detection (CED) library - detect character encodings in text
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

# compact-enc-det

[![Crates.io](https://img.shields.io/crates/v/compact-enc-det.svg)](https://crates.io/crates/compact-enc-det)
[![Documentation](https://docs.rs/compact-enc-det/badge.svg)](https://docs.rs/compact-enc-det)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](../LICENSE)

High-level Rust bindings for [Compact Encoding Detection (CED)](https://github.com/google/compact_enc_det) - a library for detecting character encodings in text.

## Features

- Safe, ergonomic Rust API
- Type-safe enums for encodings, languages, and corpus types
- Support for 75+ character encodings
- Provides reliability confidence scores
- Optional hints for improved detection accuracy

## Installation

```toml
[dependencies]
compact-enc-det = "0.1"
```

## Usage

```rust
use compact_enc_det::{detect_encoding, DetectHints, Encoding};

fn main() {
    let text = "Hello, world! 你好世界";
    let detection = detect_encoding(text.as_bytes(), DetectHints::default());

    println!("Detected: {:?}", detection.encoding);
    println!("MIME name: {}", detection.mime_name);
    println!("Reliable: {}", detection.is_reliable);

    assert_eq!(detection.encoding, Encoding::UTF8);
}
```

### Detection with Hints

```rust
use compact_enc_det::{detect_encoding, DetectHints, Language, TextCorpusType};

let hints = DetectHints {
    url_hint: "https://example.jp/page.html",
    language_hint: Some(Language::JAPANESE),
    corpus_type: TextCorpusType::WEB_CORPUS,
    ..Default::default()
};

let detection = detect_encoding(japanese_text, hints);
```

## Documentation

For complete documentation, see [docs.rs/compact-enc-det](https://docs.rs/compact-enc-det).

## License

MIT License - see [LICENSE](../LICENSE) file for details.

The underlying C++ library is licensed under Apache License 2.0.