|
58 | 58 | ) |
59 | 59 | ) |
60 | 60 | ), |
61 | | - doc = "- [Arc][pool::arc::Arc] -- like `std::sync::Arc` but backed by a lock-free memory pool rather than [global_allocator]" |
| 61 | + doc = "- [`Arc`][pool::arc::Arc]: Like `std::sync::Arc` but backed by a lock-free memory pool rather than `[global_allocator]`." |
62 | 62 | )] |
63 | 63 | #![cfg_attr( |
64 | 64 | any( |
|
75 | 75 | ) |
76 | 76 | ) |
77 | 77 | ), |
78 | | - doc = "- [Box][pool::boxed::Box] -- like `std::boxed::Box` but backed by a lock-free memory pool rather than [global_allocator]" |
| 78 | + doc = "- [`Box`][pool::boxed::Box]: Like `std::boxed::Box` but backed by a lock-free memory pool rather than `[global_allocator]`." |
79 | 79 | )] |
80 | 80 | #![cfg_attr( |
81 | 81 | any( |
|
92 | 92 | ) |
93 | 93 | ) |
94 | 94 | ), |
95 | | - doc = "- [Arc][pool::arc::Arc] -- like `std::sync::Arc` but backed by a lock-free memory pool rather than [global_allocator]" |
| 95 | + doc = "- [`Arc`][pool::arc::Arc]: Like `std::sync::Arc` but backed by a lock-free memory pool rather than `[global_allocator]`." |
96 | 96 | )] |
97 | 97 | # -- objects managed by an object pool" |
| 112 | + doc = "- [`Object`](pool::object::Object): Objects managed by an object pool." |
113 | 113 | )] |
114 | | -//! - [`BinaryHeap`] -- priority queue |
115 | | -//! - [Deque] -- double-ended queue |
116 | | -//! - [`HistoryBuf`] -- similar to a write-only ring buffer |
117 | | -//! - [`IndexMap`] -- hash table |
118 | | -//! - [`IndexSet`] -- hash set |
119 | | -//! - [`LinearMap`] |
120 | | -//! - [`sorted_linked_list::SortedLinkedList`] |
121 | | -//! - [String] |
122 | | -//! - [Vec] |
123 | | -//! - [`mpmc::Q*`](mpmc) -- multiple producer multiple consumer lock-free queue |
124 | | -//! - [spsc] and [`spsc::Queue`] -- single producer single consumer lock-free queue |
| 114 | +//! - [`BinaryHeap`]: A priority queue. |
| 115 | +//! - [`Deque`]: A double-ended queue. |
| 116 | +//! - [`HistoryBuf`]: A “history buffer”, similar to a write-only ring buffer. |
| 117 | +//! - [`IndexMap`]: A hash table. |
| 118 | +//! - [`IndexSet`]: A hash set. |
| 119 | +//! - [`LinearMap`]: A linear map. |
| 120 | +//! - [`SortedLinkedList`](sorted_linked_list::SortedLinkedList): A sorted linked list. |
| 121 | +//! - [`String`]: A string. |
| 122 | +//! - [`Vec`]: A vector. |
| 123 | +//! - [`mpmc::MpMcQueue`](mpmc): A lock-free multiple-producer, multiple-consumer queue. |
| 124 | +//! - [`spsc::Queue`](spsc): A lock-free single-producer, single-consumer queue. |
125 | 125 | //! |
126 | 126 | //! # Minimum Supported Rust Version (MSRV) |
127 | 127 | //! |
|
0 commit comments