Skip to content

Commit e114604

Browse files
slowlislowli
committed
Fix doc tests
1 parent 35f0b87 commit e114604

File tree

12 files changed

+78
-83
lines changed

12 files changed

+78
-83
lines changed

‎matterdb/src/access/mod.rs‎

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ impl<T: RawAccess> Access for T {
134134
/// # Examples
135135
///
136136
/// ```
137-
/// use matterdb::{access::{AccessExt, CopyAccessExt, Prefixed}, Database, TemporaryDB};
137+
/// use matterdb::{access::{AccessExt, Prefixed}, Database, TemporaryDB};
138138
///
139139
/// let db = TemporaryDB::new();
140140
/// let fork = db.fork();
@@ -263,8 +263,8 @@ pub enum AccessErrorKind {
263263
/// ```
264264
/// use matterdb_derive::FromAccess;
265265
/// # use matterdb::{
266-
/// # access::{Access, CopyAccessExt, AccessError, FromAccess, RawAccessMut},
267-
/// # Database, Entry, Group, Lazy, MapIndex, IndexAddress, TemporaryDB,
266+
/// # access::{Access, AccessExt, AccessError, FromAccess, RawAccessMut},
267+
/// # Database, Entry, Group, MapIndex, IndexAddress, TemporaryDB,
268268
/// # };
269269
///
270270
/// #[derive(FromAccess)]
@@ -295,11 +295,7 @@ pub enum AccessErrorKind {
295295
/// assert_eq!(map.len.get(), Some(2));
296296
/// # }
297297
///
298-
/// // Components could be used with `Group` / `Lazy` out of the box:
299-
/// let lazy_map: Lazy<_, InsertOnlyMap<_>> =
300-
/// Lazy::from_access(&fork, "test".into())?;
301-
/// assert_eq!(lazy_map.get().map.get("foo").unwrap(), "FOO");
302-
///
298+
/// // Components could be used with `Group` out of the box:
303299
/// let group_of_maps: Group<_, u16, InsertOnlyMap<_>> =
304300
/// fork.get_group("test_group");
305301
/// group_of_maps.get(&1).insert("baz", "BAZ".to_owned());

‎matterdb/src/db.rs‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -255,7 +255,7 @@ pub(crate) enum Change {
255255
/// the `flush` method.
256256
///
257257
/// ```
258-
/// # use matterdb::{access::CopyAccessExt, Database, TemporaryDB};
258+
/// # use matterdb::{access::AccessExt, Database, TemporaryDB};
259259
/// let db = TemporaryDB::new();
260260
/// let mut fork = db.fork();
261261
/// fork.get_list("list").extend(vec![1_u32, 2]);
@@ -281,7 +281,7 @@ pub(crate) enum Change {
281281
/// For example the code below will panic at runtime.
282282
///
283283
/// ```rust,should_panic
284-
/// # use matterdb::{access::CopyAccessExt, TemporaryDB, ListIndex, Database};
284+
/// # use matterdb::{access::AccessExt, TemporaryDB, ListIndex, Database};
285285
/// let db = TemporaryDB::new();
286286
/// let fork = db.fork();
287287
/// let index = fork.get_list::<_, u8>("index");
@@ -292,7 +292,7 @@ pub(crate) enum Change {
292292
/// To enable immutable / shared references to indexes, you may use [`readonly()`](Self::readonly()) method:
293293
///
294294
/// ```
295-
/// # use matterdb::{access::CopyAccessExt, TemporaryDB, ListIndex, Database};
295+
/// # use matterdb::{access::AccessExt, TemporaryDB, ListIndex, Database};
296296
/// let db = TemporaryDB::new();
297297
/// let fork = db.fork();
298298
/// fork.get_list::<_, u8>("index").extend(vec![1, 2, 3]);
@@ -324,14 +324,14 @@ pub struct Fork {
324324
///
325325
/// ```
326326
/// # use matterdb::{
327-
/// # access::CopyAccessExt, Database, Patch, TemporaryDB,
327+
/// # access::AccessExt, Database, Patch, TemporaryDB,
328328
/// # };
329329
/// let db = TemporaryDB::new();
330330
/// let fork = db.fork();
331331
/// fork.get_list("list").extend(vec![1_i32, 2, 3]);
332332
/// let patch: Patch = fork.into_patch();
333333
/// // The patch contains changes recorded in the fork.
334-
/// let list = patch.get_list::<_, i32>("list");
334+
/// let list = patch.as_ref().get_list::<_, i32>("list");
335335
/// assert_eq!(list.len(), 3);
336336
/// ```
337337
#[derive(Debug)]
@@ -375,7 +375,7 @@ enum NextIterValue {
375375
/// rather than an exclusive one (`&mut self`). This means that the following code compiles:
376376
///
377377
/// ```
378-
/// use matterdb::{access::CopyAccessExt, Database, TemporaryDB};
378+
/// use matterdb::{access::AccessExt, Database, TemporaryDB};
379379
///
380380
/// // not declared as `mut db`!
381381
/// let db: Box<dyn Database> = Box::new(TemporaryDB::new());
@@ -424,7 +424,7 @@ enum NextIterValue {
424424
///
425425
/// ```
426426
/// // NEVER USE THIS PATTERN!
427-
/// # use matterdb::{access::CopyAccessExt, Database, TemporaryDB};
427+
/// # use matterdb::{access::AccessExt, Database, TemporaryDB};
428428
/// let db = TemporaryDB::new();
429429
/// let first_fork = db.fork();
430430
/// first_fork.get_list("list").extend(vec![1, 2, 3]);
@@ -509,7 +509,7 @@ pub trait Database: Send + Sync + 'static {
509509
/// and then applying backups in the reverse order:
510510
///
511511
/// ```
512-
/// # use matterdb::{access::{Access, CopyAccessExt}, Database, DatabaseExt, TemporaryDB};
512+
/// # use matterdb::{access::{Access, AccessExt}, Database, TemporaryDB};
513513
/// let db = TemporaryDB::new();
514514
/// let fork = db.fork();
515515
/// fork.get_list("list").push(1_u32);
@@ -525,16 +525,16 @@ pub trait Database: Send + Sync + 'static {
525525
/// view.get_list("list").iter().collect()
526526
/// }
527527
///
528-
/// assert_eq!(enumerate_list(&db.snapshot()), vec![1, 2, 3, 4]);
528+
/// assert_eq!(enumerate_list(db.snapshot().as_ref()), vec![1, 2, 3, 4]);
529529
/// // Rollback the most recent merge.
530530
/// db.merge(backup3).unwrap();
531-
/// assert_eq!(enumerate_list(&db.snapshot()), vec![1, 2]);
531+
/// assert_eq!(enumerate_list(db.snapshot().as_ref()), vec![1, 2]);
532532
/// // ...Then the penultimate merge.
533533
/// db.merge(backup2).unwrap();
534-
/// assert_eq!(enumerate_list(&db.snapshot()), vec![1]);
534+
/// assert_eq!(enumerate_list(db.snapshot().as_ref()), vec![1]);
535535
/// // ...Then the oldest one.
536536
/// db.merge(backup1).unwrap();
537-
/// assert!(enumerate_list(&db.snapshot()).is_empty());
537+
/// assert!(enumerate_list(db.snapshot().as_ref()).is_empty());
538538
/// ```
539539
///
540540
/// # Performance notes
@@ -743,7 +743,7 @@ impl<'a> RawAccess for &'a Fork {
743743
/// # Examples
744744
///
745745
/// ```
746-
/// # use matterdb::{access::CopyAccessExt, Database, ReadonlyFork, TemporaryDB};
746+
/// # use matterdb::{access::AccessExt, Database, ReadonlyFork, TemporaryDB};
747747
/// let db = TemporaryDB::new();
748748
/// let fork = db.fork();
749749
/// fork.get_list("list").push(1_u32);
@@ -761,7 +761,7 @@ impl<'a> RawAccess for &'a Fork {
761761
/// There are no write methods in indexes instantiated from `ReadonlyFork`:
762762
///
763763
/// ```compile_fail
764-
/// # use matterdb::{access::CopyAccessExt, Database, ReadonlyFork, TemporaryDB};
764+
/// # use matterdb::{access::AccessExt, Database, ReadonlyFork, TemporaryDB};
765765
/// let db = TemporaryDB::new();
766766
/// let fork = db.fork();
767767
/// let readonly: ReadonlyFork<'_> = fork.readonly();

‎matterdb/src/indexes/entry.rs‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ where
4747
/// # Examples
4848
///
4949
/// ```
50-
/// use matterdb::{access::CopyAccessExt, TemporaryDB, Database, Entry};
50+
/// use matterdb::{access::AccessExt, TemporaryDB, Database, Entry};
5151
///
5252
/// let db = TemporaryDB::new();
5353
/// let fork = db.fork();
@@ -66,7 +66,7 @@ where
6666
/// # Examples
6767
///
6868
/// ```
69-
/// use matterdb::{access::CopyAccessExt, TemporaryDB, Database, Entry};
69+
/// use matterdb::{access::AccessExt, TemporaryDB, Database, Entry};
7070
///
7171
/// let db = TemporaryDB::new();
7272
/// let fork = db.fork();
@@ -91,7 +91,7 @@ where
9191
/// # Examples
9292
///
9393
/// ```
94-
/// use matterdb::{access::CopyAccessExt, TemporaryDB, Database, Entry};
94+
/// use matterdb::{access::AccessExt, TemporaryDB, Database, Entry};
9595
///
9696
/// let db = TemporaryDB::new();
9797
/// let fork = db.fork();
@@ -109,7 +109,7 @@ where
109109
/// # Examples
110110
///
111111
/// ```
112-
/// use matterdb::{access::CopyAccessExt, TemporaryDB, Database, Entry};
112+
/// use matterdb::{access::AccessExt, TemporaryDB, Database, Entry};
113113
///
114114
/// let db = TemporaryDB::new();
115115
/// let fork = db.fork();
@@ -130,7 +130,7 @@ where
130130
/// # Examples
131131
///
132132
/// ```
133-
/// use matterdb::{access::CopyAccessExt, TemporaryDB, Database, Entry};
133+
/// use matterdb::{access::AccessExt, TemporaryDB, Database, Entry};
134134
///
135135
/// let db = TemporaryDB::new();
136136
/// let fork = db.fork();
@@ -156,7 +156,7 @@ where
156156
/// # Examples
157157
///
158158
/// ```
159-
/// use matterdb::{access::CopyAccessExt, TemporaryDB, Database, Entry};
159+
/// use matterdb::{access::AccessExt, TemporaryDB, Database, Entry};
160160
///
161161
/// let db = TemporaryDB::new();
162162
/// let fork = db.fork();

‎matterdb/src/indexes/group.rs‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ use crate::{
2121
///
2222
/// ```
2323
/// # use matterdb::{
24-
/// # access::{Access, CopyAccessExt, FromAccess},
24+
/// # access::{Access, AccessExt, FromAccess},
2525
/// # Database, Group, ListIndex, TemporaryDB,
2626
/// # };
2727
/// type StrGroup<T> = Group<T, str, ListIndex<<T as Access>::Base, u64>>;
@@ -42,7 +42,7 @@ use crate::{
4242
/// # Examples
4343
///
4444
/// ```
45-
/// # use matterdb::{access::{CopyAccessExt, FromAccess}, Database, Group, ListIndex, TemporaryDB};
45+
/// # use matterdb::{access::{AccessExt, FromAccess}, Database, Group, ListIndex, TemporaryDB};
4646
/// let db = TemporaryDB::new();
4747
/// let fork = db.fork();
4848
/// let group: Group<_, u64, ListIndex<_, u64>> = fork.get_group("group");
@@ -60,7 +60,7 @@ use crate::{
6060
/// Group keys can be unsized:
6161
///
6262
/// ```
63-
/// # use matterdb::{access::CopyAccessExt, Database, Group, ListIndex, TemporaryDB};
63+
/// # use matterdb::{access::AccessExt, Database, Group, ListIndex, TemporaryDB};
6464
/// # let db = TemporaryDB::new();
6565
/// # let fork = db.fork();
6666
/// let group: Group<_, str, ListIndex<_, u64>> = fork.get_group("unsized_group");

‎matterdb/src/indexes/key_set.rs‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ where
5252
/// # Examples
5353
///
5454
/// ```
55-
/// use matterdb::{access::CopyAccessExt, TemporaryDB, Database, KeySetIndex};
55+
/// use matterdb::{access::AccessExt, TemporaryDB, Database, KeySetIndex};
5656
///
5757
/// let db = TemporaryDB::new();
5858
/// let fork = db.fork();
@@ -71,7 +71,7 @@ where
7171
/// # Examples
7272
///
7373
/// ```
74-
/// use matterdb::{access::CopyAccessExt, TemporaryDB, Database, KeySetIndex};
74+
/// use matterdb::{access::AccessExt, TemporaryDB, Database, KeySetIndex};
7575
///
7676
/// let db = TemporaryDB::new();
7777
/// let fork = db.fork();
@@ -90,7 +90,7 @@ where
9090
/// # Examples
9191
///
9292
/// ```
93-
/// use matterdb::{access::CopyAccessExt, TemporaryDB, Database, KeySetIndex};
93+
/// use matterdb::{access::AccessExt, TemporaryDB, Database, KeySetIndex};
9494
///
9595
/// let db = TemporaryDB::new();
9696
/// let fork = db.fork();
@@ -115,7 +115,7 @@ where
115115
/// # Examples
116116
///
117117
/// ```
118-
/// use matterdb::{access::CopyAccessExt, TemporaryDB, Database, KeySetIndex};
118+
/// use matterdb::{access::AccessExt, TemporaryDB, Database, KeySetIndex};
119119
///
120120
/// let db = TemporaryDB::new();
121121
/// let fork = db.fork();
@@ -133,7 +133,7 @@ where
133133
/// # Examples
134134
///
135135
/// ```
136-
/// use matterdb::{access::CopyAccessExt, TemporaryDB, Database, KeySetIndex};
136+
/// use matterdb::{access::AccessExt, TemporaryDB, Database, KeySetIndex};
137137
///
138138
/// let db = TemporaryDB::new();
139139
/// let fork = db.fork();
@@ -159,7 +159,7 @@ where
159159
/// # Examples
160160
///
161161
/// ```
162-
/// use matterdb::{access::CopyAccessExt, TemporaryDB, Database, KeySetIndex};
162+
/// use matterdb::{access::AccessExt, TemporaryDB, Database, KeySetIndex};
163163
///
164164
/// let db = TemporaryDB::new();
165165
/// let fork = db.fork();

‎matterdb/src/indexes/list.rs‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ where
5757
/// # Examples
5858
///
5959
/// ```
60-
/// use matterdb::{access::CopyAccessExt, TemporaryDB, Database, ListIndex};
60+
/// use matterdb::{access::AccessExt, TemporaryDB, Database, ListIndex};
6161
///
6262
/// let db = TemporaryDB::new();
6363
/// let fork = db.fork();
@@ -76,7 +76,7 @@ where
7676
/// # Examples
7777
///
7878
/// ```
79-
/// use matterdb::{access::CopyAccessExt, TemporaryDB, Database, ListIndex};
79+
/// use matterdb::{access::AccessExt, TemporaryDB, Database, ListIndex};
8080
///
8181
/// let db = TemporaryDB::new();
8282
/// let fork = db.fork();
@@ -98,7 +98,7 @@ where
9898
/// # Examples
9999
///
100100
/// ```
101-
/// use matterdb::{access::CopyAccessExt, TemporaryDB, Database, ListIndex};
101+
/// use matterdb::{access::AccessExt, TemporaryDB, Database, ListIndex};
102102
///
103103
/// let db = TemporaryDB::new();
104104
/// let fork = db.fork();
@@ -117,7 +117,7 @@ where
117117
/// # Examples
118118
///
119119
/// ```
120-
/// use matterdb::{access::CopyAccessExt, TemporaryDB, Database, ListIndex};
120+
/// use matterdb::{access::AccessExt, TemporaryDB, Database, ListIndex};
121121
///
122122
/// let db = TemporaryDB::new();
123123
/// let fork = db.fork();
@@ -139,7 +139,7 @@ where
139139
/// # Examples
140140
///
141141
/// ```
142-
/// use matterdb::{access::CopyAccessExt, TemporaryDB, Database, ListIndex};
142+
/// use matterdb::{access::AccessExt, TemporaryDB, Database, ListIndex};
143143
///
144144
/// let db = TemporaryDB::new();
145145
/// let fork = db.fork();
@@ -160,7 +160,7 @@ where
160160
/// # Examples
161161
///
162162
/// ```
163-
/// use matterdb::{access::CopyAccessExt, TemporaryDB, Database, ListIndex};
163+
/// use matterdb::{access::AccessExt, TemporaryDB, Database, ListIndex};
164164
///
165165
/// let db = TemporaryDB::new();
166166
/// let fork = db.fork();
@@ -187,7 +187,7 @@ where
187187
/// # Examples
188188
///
189189
/// ```
190-
/// use matterdb::{access::CopyAccessExt, TemporaryDB, Database, ListIndex};
190+
/// use matterdb::{access::AccessExt, TemporaryDB, Database, ListIndex};
191191
///
192192
/// let db = TemporaryDB::new();
193193
/// let fork = db.fork();
@@ -208,7 +208,7 @@ where
208208
/// # Examples
209209
///
210210
/// ```
211-
/// use matterdb::{access::CopyAccessExt, TemporaryDB, Database, ListIndex};
211+
/// use matterdb::{access::AccessExt, TemporaryDB, Database, ListIndex};
212212
///
213213
/// let db = TemporaryDB::new();
214214
/// let fork = db.fork();
@@ -235,7 +235,7 @@ where
235235
/// # Examples
236236
///
237237
/// ```
238-
/// use matterdb::{access::CopyAccessExt, TemporaryDB, Database, ListIndex};
238+
/// use matterdb::{access::AccessExt, TemporaryDB, Database, ListIndex};
239239
///
240240
/// let db = TemporaryDB::new();
241241
/// let fork = db.fork();
@@ -265,7 +265,7 @@ where
265265
/// # Examples
266266
///
267267
/// ```
268-
/// use matterdb::{access::CopyAccessExt, TemporaryDB, Database, ListIndex};
268+
/// use matterdb::{access::AccessExt, TemporaryDB, Database, ListIndex};
269269
///
270270
/// let db = TemporaryDB::new();
271271
/// let fork = db.fork();
@@ -293,7 +293,7 @@ where
293293
/// # Examples
294294
///
295295
/// ```
296-
/// use matterdb::{access::CopyAccessExt, TemporaryDB, Database, ListIndex};
296+
/// use matterdb::{access::AccessExt, TemporaryDB, Database, ListIndex};
297297
///
298298
/// let db = TemporaryDB::new();
299299
/// let fork = db.fork();
@@ -325,7 +325,7 @@ where
325325
/// # Examples
326326
///
327327
/// ```
328-
/// use matterdb::{access::CopyAccessExt, TemporaryDB, Database, ListIndex};
328+
/// use matterdb::{access::AccessExt, TemporaryDB, Database, ListIndex};
329329
///
330330
/// let db = TemporaryDB::new();
331331
/// let fork = db.fork();

0 commit comments

Comments
 (0)