polars_arrow/array/list/
iterator.rs

1use super::ListArray;
2use crate::array::iterator::NonNullValuesIter;
3use crate::array::{Array, ArrayAccessor, ArrayValuesIter};
4use crate::bitmap::utils::{BitmapIter, ZipValidity};
5use crate::offset::Offset;
6
7unsafe impl<'a, O: Offset> ArrayAccessor<'a> for ListArray<O> {
8    type Item = Box<dyn Array>;
9
10    #[inline]
11    unsafe fn value_unchecked(&'a self, index: usize) -> Self::Item {
12        self.value_unchecked(index)
13    }
14
15    #[inline]
16    fn len(&self) -> usize {
17        self.len()
18    }
19}
20
21/// Iterator of values of a [`ListArray`].
22pub type ListValuesIter<'a, O> = ArrayValuesIter<'a, ListArray<O>>;
23
24type ZipIter<'a, O> = ZipValidity<Box<dyn Array>, ListValuesIter<'a, O>, BitmapIter<'a>>;
25
26impl<'a, O: Offset> IntoIterator for &'a ListArray<O> {
27    type Item = Option<Box<dyn Array>>;
28    type IntoIter = ZipIter<'a, O>;
29
30    fn into_iter(self) -> Self::IntoIter {
31        self.iter()
32    }
33}
34
35impl<'a, O: Offset> ListArray<O> {
36    /// Returns an iterator of `Option<Box<dyn Array>>`
37    pub fn iter(&'a self) -> ZipIter<'a, O> {
38        ZipValidity::new_with_validity(ListValuesIter::new(self), self.validity.as_ref())
39    }
40
41    /// Returns an iterator of `Box<dyn Array>`
42    pub fn values_iter(&'a self) -> ListValuesIter<'a, O> {
43        ListValuesIter::new(self)
44    }
45
46    /// Returns an iterator of the non-null values `Box<dyn Array>`.
47    #[inline]
48    pub fn non_null_values_iter(&'a self) -> NonNullValuesIter<'a, ListArray<O>> {
49        NonNullValuesIter::new(self, self.validity())
50    }
51}