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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
|
# Rust-PHF
[](https://github.com/rust-phf/rust-phf/actions/workflows/ci.yml) [](https://crates.io/crates/phf)
[Documentation](https://docs.rs/phf)
Rust-PHF is a library to generate efficient lookup tables at compile time using
[perfect hash functions](http://en.wikipedia.org/wiki/Perfect_hash_function).
It currently uses the
[CHD algorithm](http://cmph.sourceforge.net/papers/esa09.pdf) and can generate
a 100,000 entry map in roughly .4 seconds.
MSRV (minimum supported rust version) is Rust 1.66.
## Usage
PHF data structures can be constructed via either the procedural
macros in the `phf_macros` crate or code generation supported by the
`phf_codegen` crate.
To compile the `phf` crate with a dependency on
libcore instead of libstd, enabling use in environments where libstd
will not work, set `default-features = false` for the dependency:
```toml
[dependencies]
# to use `phf` in `no_std` environments
phf = { version = "0.13.1", default-features = false }
```
### phf_macros
```rust
use phf::phf_map;
#[derive(Clone)]
pub enum Keyword {
Loop,
Continue,
Break,
Fn,
Extern,
}
static KEYWORDS: phf::Map<&'static str, Keyword> = phf_map! {
"loop" => Keyword::Loop,
"continue" => Keyword::Continue,
"break" => Keyword::Break,
"fn" => Keyword::Fn,
"extern" => Keyword::Extern,
};
// You can also use OR (`|`) patterns to map multiple keys to the same value:
static OPERATORS: phf::Map<&'static str, &'static str> = phf_map! {
"+" | "add" | "plus" => "addition",
"-" | "sub" | "minus" => "subtraction",
"*" | "mul" | "times" => "multiplication",
};
pub fn parse_keyword(keyword: &str) -> Option<Keyword> {
KEYWORDS.get(keyword).cloned()
}
pub fn parse_operator(operator: &str) -> Option<&'static str> {
OPERATORS.get(operator).copied()
}
```
```toml
[dependencies]
phf = { version = "0.13.1", features = ["macros"] }
```
#### Note
Currently, the macro syntax has some limitations and may not
work as you want. See [#196] for example.
[#196]: https://github.com/rust-phf/rust-phf/issues/196
### phf_codegen
To use `phf_codegen` on build.rs, you have to add dependencies under `[build-dependencies]`:
```toml
[build-dependencies]
phf = { version = "0.13.1", default-features = false }
phf_codegen = "0.13.1"
```
Then put code on build.rs:
```rust
use std::env;
use std::fs::File;
use std::io::{BufWriter, Write};
use std::path::Path;
fn main() {
let path = Path::new(&env::var("OUT_DIR").unwrap()).join("codegen.rs");
let mut file = BufWriter::new(File::create(&path).unwrap());
write!(
&mut file,
"static KEYWORDS: phf::Map<&'static str, Keyword> = {}",
phf_codegen::Map::new()
.entry("loop", "Keyword::Loop")
.entry("continue", "Keyword::Continue")
.entry("break", "Keyword::Break")
.entry("fn", "Keyword::Fn")
.entry("extern", "Keyword::Extern")
.build()
)
.unwrap();
write!(&mut file, ";\n").unwrap();
// Example with OR patterns (note: phf_codegen doesn't support OR patterns directly)
write!(
&mut file,
"static OPERATORS: phf::Map<&'static str, &'static str> = {}",
phf_codegen::Map::new()
.entry("+", "\"addition\"")
.entry("add", "\"addition\"")
.entry("plus", "\"addition\"")
.entry("-", "\"subtraction\"")
.entry("sub", "\"subtraction\"")
.entry("minus", "\"subtraction\"")
.build()
)
.unwrap();
write!(&mut file, ";\n").unwrap();
}
```
and lib.rs:
```rust
#[derive(Clone)]
enum Keyword {
Loop,
Continue,
Break,
Fn,
Extern,
}
include!(concat!(env!("OUT_DIR"), "/codegen.rs"));
pub fn parse_keyword(keyword: &str) -> Option<Keyword> {
KEYWORDS.get(keyword).cloned()
}
pub fn parse_operator(operator: &str) -> Option<&'static str> {
OPERATORS.get(operator).copied()
}
```
|
