Non-empty data structures for Rust.
Other crates are more focused for a single data structure (e.g. Vec or HashMap).
The goal of this crate is to contain non-empty implementations for all commonly used data structures.
Of course, "all" is quite a lot. I intend to add to this as I need non-empty data structures. If you need one, PRs are extremely welcome!
Expressing constraints in the type system is powerful, and non-empty data structures are no exception.
A data structure that is impossible to be empty frees developers from needing to check for the empty case, and allows them to express an expectation in their types rather than solely at runtime or in their documentation.
This also enables some convenience features or even performance improvements.
For example, an unempty::Vec can always fulfill a call to first or last, so these don't need to be Option.
This crate is using pre-release semver for now (0.x.y) while the API is being stabilized.
Once all commonly used methods for commonly used data structures exist, it'll be set to 1.0.0 to provide clarity on forwards compatibility.
"Commonly used" is of course subjective, but in general, this means:
- Commonly used data structures:
Vec,HashSet,HashMap,VecDequeuefrom the standard library. - Commonly used methods: basic methods to push to, pop from, iterate over, and create these data structures, along with conversions to/from the "commonly used data structures" list.
Unstable / nightly only APIs aren't initially planned.
More esoteric APIs (for example, try_reserve) will be implemented as needed. If you need one of these methods, please submit a PR or issue!