Skip to content

Commit 82a173f

Browse files
committed
Update SkipSet docs to use deref
1 parent cbd2557 commit 82a173f

File tree

1 file changed

+20
-20
lines changed

1 file changed

+20
-20
lines changed

crossbeam-skiplist/src/set.rs

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -85,9 +85,9 @@ where
8585
///
8686
/// let set = SkipSet::new();
8787
/// set.insert(1);
88-
/// assert_eq!(*set.front().unwrap().value(), 1);
88+
/// assert_eq!(*set.front().unwrap(), 1);
8989
/// set.insert(2);
90-
/// assert_eq!(*set.front().unwrap().value(), 1);
90+
/// assert_eq!(*set.front().unwrap(), 1);
9191
/// ```
9292
pub fn front(&self) -> Option<Entry<'_, T>> {
9393
self.inner.front().map(Entry::new)
@@ -102,9 +102,9 @@ where
102102
///
103103
/// let set = SkipSet::new();
104104
/// set.insert(1);
105-
/// assert_eq!(*set.back().unwrap().value(), 1);
105+
/// assert_eq!(*set.back().unwrap(), 1);
106106
/// set.insert(2);
107-
/// assert_eq!(*set.back().unwrap().value(), 2);
107+
/// assert_eq!(*set.back().unwrap(), 2);
108108
/// ```
109109
pub fn back(&self) -> Option<Entry<'_, T>> {
110110
self.inner.back().map(Entry::new)
@@ -137,7 +137,7 @@ where
137137
/// use crossbeam_skiplist::SkipSet;
138138
///
139139
/// let set: SkipSet<_> = (1..=3).collect();
140-
/// assert_eq!(*set.get(&3).unwrap().value(), 3);
140+
/// assert_eq!(*set.get(&3).unwrap(), 3);
141141
/// assert!(set.get(&4).is_none());
142142
/// ```
143143
pub fn get<Q>(&self, key: &Q) -> Option<Entry<'_, T>>
@@ -164,10 +164,10 @@ where
164164
/// set.insert(12);
165165
///
166166
/// let greater_than_five = set.lower_bound(Excluded(&5)).unwrap();
167-
/// assert_eq!(*greater_than_five.value(), 6);
167+
/// assert_eq!(*greater_than_five, 6);
168168
///
169169
/// let greater_than_six = set.lower_bound(Excluded(&6)).unwrap();
170-
/// assert_eq!(*greater_than_six.value(), 7);
170+
/// assert_eq!(*greater_than_six, 7);
171171
///
172172
/// let greater_than_thirteen = set.lower_bound(Excluded(&13));
173173
/// assert!(greater_than_thirteen.is_none());
@@ -196,7 +196,7 @@ where
196196
/// set.insert(12);
197197
///
198198
/// let less_than_eight = set.upper_bound(Excluded(&8)).unwrap();
199-
/// assert_eq!(*less_than_eight.value(), 7);
199+
/// assert_eq!(*less_than_eight, 7);
200200
///
201201
/// let less_than_six = set.upper_bound(Excluded(&6));
202202
/// assert!(less_than_six.is_none());
@@ -218,7 +218,7 @@ where
218218
///
219219
/// let set = SkipSet::new();
220220
/// let entry = set.get_or_insert(2);
221-
/// assert_eq!(*entry.value(), 2);
221+
/// assert_eq!(*entry, 2);
222222
/// ```
223223
pub fn get_or_insert(&self, key: T) -> Entry<'_, T> {
224224
Entry::new(self.inner.get_or_insert(key, ()))
@@ -237,9 +237,9 @@ where
237237
/// set.insert(12);
238238
///
239239
/// let mut set_iter = set.iter();
240-
/// assert_eq!(*set_iter.next().unwrap().value(), 6);
241-
/// assert_eq!(*set_iter.next().unwrap().value(), 7);
242-
/// assert_eq!(*set_iter.next().unwrap().value(), 12);
240+
/// assert_eq!(*set_iter.next().unwrap(), 6);
241+
/// assert_eq!(*set_iter.next().unwrap(), 7);
242+
/// assert_eq!(*set_iter.next().unwrap(), 12);
243243
/// assert!(set_iter.next().is_none());
244244
/// ```
245245
pub fn iter(&self) -> Iter<'_, T> {
@@ -261,8 +261,8 @@ where
261261
/// set.insert(12);
262262
///
263263
/// let mut set_range = set.range(5..=8);
264-
/// assert_eq!(*set_range.next().unwrap().value(), 6);
265-
/// assert_eq!(*set_range.next().unwrap().value(), 7);
264+
/// assert_eq!(*set_range.next().unwrap(), 6);
265+
/// assert_eq!(*set_range.next().unwrap(), 7);
266266
/// assert!(set_range.next().is_none());
267267
/// ```
268268
pub fn range<Q, R>(&self, range: R) -> Range<'_, Q, R, T>
@@ -293,7 +293,7 @@ where
293293
///
294294
/// let set = SkipSet::new();
295295
/// set.insert(2);
296-
/// assert_eq!(*set.get(&2).unwrap().value(), 2);
296+
/// assert_eq!(*set.get(&2).unwrap(), 2);
297297
/// ```
298298
pub fn insert(&self, key: T) -> Entry<'_, T> {
299299
Entry::new(self.inner.insert(key, ()))
@@ -311,7 +311,7 @@ where
311311
///
312312
/// let set = SkipSet::new();
313313
/// set.insert(2);
314-
/// assert_eq!(*set.remove(&2).unwrap().value(), 2);
314+
/// assert_eq!(*set.remove(&2).unwrap(), 2);
315315
/// assert!(set.remove(&2).is_none());
316316
/// ```
317317
pub fn remove<Q>(&self, key: &Q) -> Option<Entry<'_, T>>
@@ -337,8 +337,8 @@ where
337337
/// set.insert(1);
338338
/// set.insert(2);
339339
///
340-
/// assert_eq!(*set.pop_front().unwrap().value(), 1);
341-
/// assert_eq!(*set.pop_front().unwrap().value(), 2);
340+
/// assert_eq!(*set.pop_front().unwrap(), 1);
341+
/// assert_eq!(*set.pop_front().unwrap(), 2);
342342
///
343343
/// // All entries have been removed now.
344344
/// assert!(set.is_empty());
@@ -362,8 +362,8 @@ where
362362
/// set.insert(1);
363363
/// set.insert(2);
364364
///
365-
/// assert_eq!(*set.pop_back().unwrap().value(), 2);
366-
/// assert_eq!(*set.pop_back().unwrap().value(), 1);
365+
/// assert_eq!(*set.pop_back().unwrap(), 2);
366+
/// assert_eq!(*set.pop_back().unwrap(), 1);
367367
///
368368
/// // All entries have been removed now.
369369
/// assert!(set.is_empty());

0 commit comments

Comments
 (0)