Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Robbepop/string-interner
A data structure to efficiently intern, cache and restore strings.
https://github.com/Robbepop/string-interner
bidirectional datastructures interner interning mapping rust storage string
Last synced: about 1 month ago
JSON representation
A data structure to efficiently intern, cache and restore strings.
- Host: GitHub
- URL: https://github.com/Robbepop/string-interner
- Owner: Robbepop
- License: other
- Created: 2017-01-27T11:43:06.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-06-20T11:13:54.000Z (6 months ago)
- Last Synced: 2024-10-29T16:42:16.650Z (about 2 months ago)
- Topics: bidirectional, datastructures, interner, interning, mapping, rust, storage, string
- Language: Rust
- Homepage:
- Size: 2.98 MB
- Stars: 172
- Watchers: 5
- Forks: 29
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# String Interner
| Continuous Integration | Test Coverage | Documentation | Crates.io |
|:----------------------:|:--------------------:|:----------------:|:--------------------:|
| [![travisCI][1]][2] | [![codecov][5]][6] | [![docs][9]][10] | [![crates][11]][12] |
A data structure to cache strings efficiently, with minimal memory footprint and the ability to assicate
the interned strings with unique symbols.
These symbols allow for constant time comparisons and look-ups to the underlying interned string contents.
Also, iterating through the interned strings is cache efficient.
[1]: https://github.com/Robbepop/string-interner/workflows/Rust%20-%20Continuous%20Integration/badge.svg?branch=master
[2]: https://github.com/Robbepop/string-interner/actions?query=workflow%3A%22Rust+-+Continuous+Integration%22+branch%3Amaster
[5]: https://codecov.io/gh/robbepop/string-interner/branch/master/graph/badge.svg
[6]: https://codecov.io/gh/Robbepop/string-interner/branch/master
[9]: https://docs.rs/string-interner/badge.svg
[10]: https://docs.rs/string-interner
[11]: https://img.shields.io/crates/v/string-interner.svg
[12]: https://crates.io/crates/string-interner
[license-mit-badge]: https://img.shields.io/badge/license-MIT-blue.svg
[license-apache-badge]: https://img.shields.io/badge/license-APACHE-orange.svg
## Contributing
### Testing
Test the project using
```
cargo test --release
```
### Memory Allocation Tests
To further test memory consumption and allocations performed by the
different string interner backends test the project as follows:
```
cargo test --release --features test-allocations -- --test-threads 1
```
- The `--features test-allocations` enables the memory allocations tests.
- The `--test-thread 1` argument is required for the memory allocations tests
since otherwise they interfere with each other causing them to randomly fail.
- Use `--nocapture` to receive verbose output useful for debugging.
### Profiling & Benchmarks
Benchmark the string interner and its various backends using
```
cargo bench
```
## License
Licensed under either of
* Apache license, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
* MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
at your option.
### Dual licence: [![badge][license-mit-badge]](LICENSE-MIT) [![badge][license-apache-badge]](LICENSE-APACHE)
### Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as below, without any
additional terms or conditions.