Skip to content

Commit 96b7844

Browse files
Update src/raw/array.rs
Co-authored-by: Isabel Atkinson <[email protected]>
1 parent 23b7053 commit 96b7844

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

src/raw/array.rs

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -222,7 +222,16 @@ impl RawArray {
222222
self.doc.is_empty()
223223
}
224224

225-
/// Returns an iterator over the `RawElement`s in the array.
225+
/// Gets an iterator over the elements in the [`RawArray`],
226+
/// which yields `Result<RawElement<'_>>` values. These hold a
227+
/// reference to the underlying array but do not explicitly
228+
/// resolve the values.
229+
///
230+
/// This iterator, which underpins the implementation of the
231+
/// default iterator, produces `RawElement` objects that hold a
232+
/// view onto the array but do not parse out or construct
233+
/// values until the `.value()` or `.try_into()` methods are
234+
/// called.
226235
pub fn iter_elements(&self) -> RawIter {
227236
RawIter::new(&self.doc)
228237
}

0 commit comments

Comments
 (0)