From 4cc4f8d5e07a4aa85ac52ce3205574e37ffdf780 Mon Sep 17 00:00:00 2001 From: Charlotte Pabst Date: Mon, 25 Mar 2024 02:25:43 +0100 Subject: generational references & documentation --- src/entity_iterator.rs | 3 +++ 1 file changed, 3 insertions(+) (limited to 'src/entity_iterator.rs') 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> { -- cgit v1.2.3