charmap 0.1.1

A library for one-to-(none/one/many) character mapping.
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
76
77
78
79
80
81
82
83
84
85
86
87
88

# charmap

[![Build Status](https://img.shields.io/github/actions/workflow/status/owo/charmap/test.yaml)](https://github.com/owo/charmap/actions/workflows/test.yaml)
[![crates.io](https://img.shields.io/crates/v/charmap)](https://crates.io/crates/charmap)
[![Documentation](https://img.shields.io/docsrs/charmap)](https://docs.rs/charmap)
[![License](https://img.shields.io/crates/l/charmap)](https://github.com/owo/charmap#license)

A Rust library for one-to-(none/one/many) character mapping.
It's main use-case is preprocessing, transliterating, and cleaning natural
language text.

## Usage

To use `charmap` with libstd's mapping types
([`HashMap`](https://doc.rust-lang.org/std/collections/struct.HashMap.html) and
[`BTreeMap`](https://doc.rust-lang.org/std/collections/struct.BTreeMap.html)),
add the following to your `Cargo.toml`:

```toml
[dependencies]
charmap = "0.1"
```

This should also allow you to use
[`rustc-hash`](https://crates.io/crates/rustc-hash)'s
[`FxHashMap`](https://docs.rs/rustc-hash/latest/rustc_hash/type.FxHashMap.html)
since it is an instance of libstd's
[`HashMap`](https://doc.rust-lang.org/std/collections/struct.HashMap.html).

`charmap` also supports [`hashbrown`](https://crates.io/crates/hashbrown)'s
[`HashMap`](https://docs.rs/hashbrown/0.13.2/hashbrown/struct.HashMap.html) and
[`phf`](https://crates.io/crates/phf)'s
[`Map`](https://docs.rs/phf/latest/phf/struct.Map.html) and
[`OrderedMap`](https://docs.rs/phf/latest/phf/struct.OrderedMap.html) types.
You can enable these by setting the `'hashbrown'` and `'phf'` features
respectively.
For example, to use `charmap` with [`phf`](https://crates.io/crates/phf),
add the following to your `Cargo.toml`:

```toml
[dependencies]
charmap = {version = "0.1", features = ["phf"]}
```

You can also disable libstd support for `no_std` builds by setting
`default-features = false`. For example:

```toml
[dependencies]
charmap = {version = "0.1", default-features = false, features = ["phf"]}
```

## Example

Below is an example of how to use `charmap` with libstd's
[`HashMap`](https://doc.rust-lang.org/std/collections/struct.HashMap.html):

```rust
use std::collections::HashMap;
use charmap::*;

// We first define our action map that will tell our CharMapper what to do
// when it sees a particular character.
let actions = HashMap::from([
    ('!', CharMapAction::Delete),  // Delete instances of '!'
    ('l', CharMapAction::Sub("LLL")),  // Substitute instances of 'l' with 'LLL'
]);

// This is the string we want to charmap.
let start_str = "Hello, world!";

// Create a character mapper using the previously defined actions while
// allowing all other character to be output as they are.
let mapper = CharMapper::new(&actions, CharMapAction::Pass);

// Use mapper to charmap start_str
let mapped_str: String = start_str.chars().map_chars(&mapper).collect();

// Output should be: HeLLLLLLo, worLLLd
println!("{}", mapped_str);
```

## License

CharMap is distributed under the terms of both the MIT license and the
Apache License (Version 2.0).

See [LICENSE-MIT](LICENSE-MIT) and [LICENSE-APACHE](LICENSE-APACHE) for details.