Skip to content

Commit dc3585d

Browse files
committed
re-update comment
1 parent 6930185 commit dc3585d

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
@@ -213,7 +213,16 @@ impl RawArray {
213213
self.doc.is_empty()
214214
}
215215

216-
/// Returns an iterator over the `RawElement`s in the array.
216+
/// Gets an iterator over the elements in the [`RawArray`],
217+
/// which yields `Result<RawElement<'_>>` values. These hold a
218+
/// reference to the underlying array but do not explicitly
219+
/// resolve the values.
220+
///
221+
/// This iterator, which underpins the implementation of the
222+
/// default iterator, produces `RawElement` objects that hold a
223+
/// view onto the array but do not parse out or construct
224+
/// values until the `.value()` or `.try_into()` methods are
225+
/// called.
217226
pub fn iter_elements(&self) -> RawIter {
218227
RawIter::new(&self.doc)
219228
}

0 commit comments

Comments
 (0)