diff options
Diffstat (limited to 'src/entity_iterator.rs')
| -rw-r--r-- | src/entity_iterator.rs | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/src/entity_iterator.rs b/src/entity_iterator.rs index 2e8c906..f293dae 100644 --- a/src/entity_iterator.rs +++ b/src/entity_iterator.rs @@ -1,5 +1,8 @@ use crate::*; +/// An iterator over a linked list of entities. +/// +/// See the various `.iter_*()` methods on [`Ptr`] for details. pub struct EntityIterator<'tok, 'brand, 'arena, T>(Option<(lens_t!(T), lens_t!(T))>); impl<'tok, 'brand, 'arena, T> Clone for EntityIterator<'tok, 'brand, 'arena, T> { |