No description
Find a file
Tin Švagelj 7aab6c85d6
Some checks failed
Rust - Continuous Integration / Build (push) Has been cancelled
Rust - Continuous Integration / Build-1 (push) Has been cancelled
Rust - Continuous Integration / Build-2 (push) Has been cancelled
Rust - Continuous Integration / Test (push) Has been cancelled
Rust - Continuous Integration / Test-1 (push) Has been cancelled
Rust - Continuous Integration / Test-2 (push) Has been cancelled
Rust - Continuous Integration / Test Memory Consumption (push) Has been cancelled
Rust - Continuous Integration / Test Memory Consumption-1 (push) Has been cancelled
Rust - Continuous Integration / Test Memory Consumption-2 (push) Has been cancelled
Rust - Continuous Integration / Formatting (push) Has been cancelled
Rust - Continuous Integration / Documentation (push) Has been cancelled
Rust - Continuous Integration / Clippy (push) Has been cancelled
Rust - Continuous Integration / Outdated (push) Has been cancelled
Rust - Continuous Integration / Audit (push) Has been cancelled
Rust - Continuous Integration / Miri (push) Has been cancelled
Rust - Continuous Integration / Coverage (push) Has been cancelled
Fix benchmark compilation
Signed-off-by: Tin Švagelj <tin.svagelj@live.com>
2024-11-23 10:59:30 +01:00
.github/workflows Clean-up dependencies, do some chores (#73) 2024-11-12 23:18:22 +01:00
benches Fix benchmark compilation 2024-11-23 10:59:30 +01:00
src Fix benchmark compilation 2024-11-23 10:59:30 +01:00
tests Fix tests 2024-11-20 02:51:12 +01:00
.gitignore Clean-up dependencies, do some chores (#73) 2024-11-12 23:18:22 +01:00
.rustfmt.toml modernize Rust formatting (#59) 2024-02-06 14:37:35 +01:00
Cargo.lock Prepare release of string-interner v0.18.0 (#74) 2024-11-12 23:56:34 +01:00
Cargo.toml Prepare release of string-interner v0.18.0 (#74) 2024-11-12 23:56:34 +01:00
LICENSE-APACHE update license copyright years 2020-07-12 16:34:33 +02:00
LICENSE-MIT update license copyright years 2020-07-12 16:34:33 +02:00
README.md fix "allocatios" typo (#52) 2023-04-17 15:07:27 +02:00
RELEASE_NOTES.md Prepare release of string-interner v0.18.0 (#74) 2024-11-12 23:56:34 +01:00

String Interner

Continuous Integration Test Coverage Documentation Crates.io
travisCI codecov docs crates

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.

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

at your option.

Dual licence: badge badge

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.