Skip to content

Commit 4868359

Browse files
committed
DOC: Edit README and release notes for 1.3. Clean up a bit in the readme.
1 parent 899fc93 commit 4868359

File tree

1 file changed

+12
-25
lines changed

1 file changed

+12
-25
lines changed

README.rst

Lines changed: 12 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@ indexmap
1515
.. |rustc| image:: https://img.shields.io/badge/rust-1.18%2B-orange.svg
1616
.. _rustc: https://img.shields.io/badge/rust-1.18%2B-orange.svg
1717

18-
A safe, pure-Rust hash table which preserves insertion order.
18+
A safe, pure-Rust hash table which preserves (in a limited sense) insertion
19+
order.
1920

2021
This crate implements compact map and set data-structures,
2122
where the iteration order of the keys is independent from their hash or
@@ -72,30 +73,6 @@ which is roughly:
7273

7374
.. _PR45282: https://github.com/rust-lang/rust/pull/45282
7475

75-
Interesting Features
76-
--------------------
77-
78-
- Insertion order is preserved (``.swap_remove()`` perturbs the order, like the method name says).
79-
- Implements ``.pop() -> Option<(K, V)>`` in O(1) time.
80-
- ``IndexMap::new()`` is empty and uses no allocation until you insert something.
81-
- Lookup key-value pairs by index and vice versa.
82-
- No ``unsafe``.
83-
- Supports ``IndexMut``.
84-
85-
86-
Where to go from here?
87-
----------------------
88-
89-
- Ideas and PRs for how to implement insertion-order preserving remove (for example tombstones)
90-
are welcome. The plan is to split the crate into two hash table implementations
91-
a) the current compact index space version and b) the full insertion order version.
92-
93-
94-
Ideas that we already did
95-
-------------------------
96-
97-
- It can be an *indexable* ordered map in the current fashion
98-
(This was implemented in 0.2.0, for potential use as a graph datastructure).
9976

10077
- Idea for more cache efficient lookup (This was implemented in 0.1.2).
10178

@@ -109,6 +86,16 @@ Ideas that we already did
10986
Recent Changes
11087
==============
11188

89+
- 1.3.0
90+
91+
- The deprecation messages in the previous version have been removed.
92+
(The methods have not otherwise changed.) Docs for removal methods have been
93+
improved.
94+
- From Rust 1.36, this crate supports being built **without std**, requiring
95+
``alloc`` instead. This is enabled automatically when it is detected that
96+
``std`` is not available. There is no crate feature to enable/disable to
97+
trigger this. The new build-dep ``autocfg`` enables this.
98+
11299
- 1.2.0
113100

114101
- Plain ``.remove()`` now has a deprecation message, it informs the user

0 commit comments

Comments
 (0)