1# String Interner
2
3| Continuous Integration |     Test Coverage    |  Documentation   |       Crates.io      |
4|:----------------------:|:--------------------:|:----------------:|:--------------------:|
5| [![travisCI][1]][2]    | [![codecov][5]][6]   | [![docs][9]][10] | [![crates][11]][12]  |
6
7A data structure to cache strings efficiently, with minimal memory footprint and the ability to assicate
8the interned strings with unique symbols.
9These symbols allow for constant time comparisons and look-ups to the underlying interned string contents.
10Also, iterating through the interned strings is cache efficient.
11
12## License
13
14Licensed under either of
15
16 * Apache license, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
17 * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
18
19at your option.
20
21### Dual licence: [![badge][license-mit-badge]](LICENSE-MIT) [![badge][license-apache-badge]](LICENSE-APACHE)
22
23### Contribution
24
25Unless you explicitly state otherwise, any contribution intentionally submitted
26for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any
27additional terms or conditions.
28
29[1]: https://github.com/Robbepop/string-interner/workflows/Rust%20-%20Continuous%20Integration/badge.svg?branch=master
30[2]: https://github.com/Robbepop/string-interner/actions?query=workflow%3A%22Rust+-+Continuous+Integration%22+branch%3Amaster
31[5]:  https://codecov.io/gh/robbepop/string-interner/branch/master/graph/badge.svg
32[6]:  https://codecov.io/gh/Robbepop/string-interner/branch/master
33[9]:  https://docs.rs/string-interner/badge.svg
34[10]: https://docs.rs/string-interner
35[11]: https://img.shields.io/crates/v/string-interner.svg
36[12]: https://crates.io/crates/string-interner
37
38[license-mit-badge]: https://img.shields.io/badge/license-MIT-blue.svg
39[license-apache-badge]: https://img.shields.io/badge/license-APACHE-orange.svg
40