Adding `linked_hash_set` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add linked_hash_set

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

linked_hash_set = "0.1.6"

The linked_hash_set library will be automatically available globally. Read the linked_hash_set library documentation.

Back to the crate overview.

Readme

linked_hash_set

This library provides an hashed set with predictable iteration order, based on the insertion order of elements. It is implemented as a linked_hash_map::LinkedHashMap where the value is (), in a similar way as HashSet is implemented from HashMap in stdlib.

Comparison with std `HashSet`

General usage is very similar to a traditional hashed set, but this structure also maintains insertion order.

Compared to HashSet, a LinkedHashSet uses an additional doubly-linked list running through its entries. As such methods front(), pop_front(), back(), pop_back() and refresh() are provided.

Comparison with `IndexSet`

Compared to indexmap::IndexSet, while both maintain insertion order a LinkedHashSet uses a linked list allowing performant removals that don't affect the order of the remaining elements. However, when this distinction is unimportant indexmap should be the faster option.

Example

let mut set = linked_hash_set::LinkedHashSet::new();
assert!(set.insert(234));
assert!(set.insert(123));
assert!(set.insert(345));
assert!(!set.insert(123)); // Also see `insert_if_absent` which won't change order

assert_eq!(set.into_iter().collect::<Vec<_>>(), vec![234, 345, 123]);

Minimum supported rust compiler

This crate is maintained with latest stable rust.

Adding linked_hash_set library as a dependency

Adding `linked_hash_set` library as a dependency