Skip to content

Commit cbd406e

Browse files
authored
Merge pull request #436 from timonvo/update-implemented-structure-docs
Add missing entries to list of implemented data structures in crate docs.
2 parents e23e9b6 + 42e6963 commit cbd406e

File tree

2 files changed

+5
-0
lines changed

2 files changed

+5
-0
lines changed

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
2222

2323
- Fixed clippy lints.
2424
- Fixed `{arc,box,object}_pool!` emitting clippy lints for `CamelCase` and `SNAKE_CASE`.
25+
- Fixed the list of implemented data structures in the crate docs, by adding `Deque`,
26+
`HistoryBuffer` and `SortedLinkedList` to the list.
2527

2628
## [v0.8.0] - 2023-11-07
2729

src/lib.rs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,13 +51,16 @@
5151
doc = "- [`Box`](pool::boxed::Box) -- like `std::boxed::Box` but backed by a lock-free memory pool rather than `#[global_allocator]`"
5252
)]
5353
//! - [`BinaryHeap`] -- priority queue
54+
//! - [`Deque`] -- double-ended queue
55+
//! - [`HistoryBuffer`] -- similar to a write-only ring buffer
5456
//! - [`IndexMap`] -- hash table
5557
//! - [`IndexSet`] -- hash set
5658
//! - [`LinearMap`]
5759
#![cfg_attr(
5860
any(arm_llsc, target_arch = "x86"),
5961
doc = "- [`Object`](pool::object::Object) -- objects managed by an object pool"
6062
)]
63+
//! - [`sorted_linked_list::SortedLinkedList`]
6164
//! - [`String`]
6265
//! - [`Vec`]
6366
//! - [`mpmc::Q*`](mpmc) -- multiple producer multiple consumer lock-free queue

0 commit comments

Comments
 (0)