diff options
| author | Charlotte Pabst <charlotte.pabst@stud.tu-darmstadt.de> | 2024-03-25 02:25:43 +0100 |
|---|---|---|
| committer | Charlotte Pabst <charlotte.pabst@stud.tu-darmstadt.de> | 2024-03-25 02:25:43 +0100 |
| commit | 4cc4f8d5e07a4aa85ac52ce3205574e37ffdf780 (patch) | |
| tree | 4a4a6c864e25ab8df5f6547b490428b23c6c5d14 /src/entity_iterator.rs | |
| parent | 1f92f06d21289019ca8a955b9162da66d98badfe (diff) | |
| download | dcel-4cc4f8d5e07a4aa85ac52ce3205574e37ffdf780.tar.xz | |
generational references & documentation
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> { |