1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
use std::sync::Arc;
use crate::{
bitmap::Bitmap,
datatypes::{DataType, Field},
error::ArrowError,
};
use super::{new_empty_array, new_null_array, Array};
mod ffi;
pub(super) mod fmt;
mod iterator;
#[derive(Clone)]
pub struct StructArray {
data_type: DataType,
values: Vec<Arc<dyn Array>>,
validity: Option<Bitmap>,
}
impl StructArray {
pub fn try_new(
data_type: DataType,
values: Vec<Arc<dyn Array>>,
validity: Option<Bitmap>,
) -> Result<Self, ArrowError> {
let fields = Self::try_get_fields(&data_type)?;
if fields.is_empty() {
return Err(ArrowError::oos(
"A StructArray must contain at least one field",
));
}
if fields.len() != values.len() {
return Err(ArrowError::oos(
"A StructArray must a number of fields in its DataType equal to the number of child values",
));
}
fields
.iter().map(|a| &a.data_type)
.zip(values.iter().map(|a| a.data_type()))
.enumerate()
.try_for_each(|(index, (data_type, child))| {
if data_type != child {
Err(ArrowError::oos(format!(
"The children DataTypes of a StructArray must equal the children data types.
However, the field {index} has data type {data_type:?} but the value has data type {child:?}"
)))
} else {
Ok(())
}
})?;
let len = values[0].len();
values
.iter()
.map(|a| a.len())
.enumerate()
.try_for_each(|(index, a_len)| {
if a_len != len {
Err(ArrowError::oos(format!(
"The children DataTypes of a StructArray must equal the children data types.
However, the values {index} has a length of {a_len}, which is different from values 0, {len}."
)))
} else {
Ok(())
}
})?;
if validity
.as_ref()
.map_or(false, |validity| validity.len() != len)
{
return Err(ArrowError::oos(
"The validity length of a StructArray must match its number of elements",
));
}
Ok(Self {
data_type,
values,
validity,
})
}
pub fn new(data_type: DataType, values: Vec<Arc<dyn Array>>, validity: Option<Bitmap>) -> Self {
Self::try_new(data_type, values, validity).unwrap()
}
pub fn from_data(
data_type: DataType,
values: Vec<Arc<dyn Array>>,
validity: Option<Bitmap>,
) -> Self {
Self::new(data_type, values, validity)
}
pub fn new_empty(data_type: DataType) -> Self {
if let DataType::Struct(fields) = &data_type {
let values = fields
.iter()
.map(|field| new_empty_array(field.data_type().clone()).into())
.collect();
Self::new(data_type, values, None)
} else {
panic!("StructArray must be initialized with DataType::Struct");
}
}
pub fn new_null(data_type: DataType, length: usize) -> Self {
if let DataType::Struct(fields) = &data_type {
let values = fields
.iter()
.map(|field| new_null_array(field.data_type().clone(), length).into())
.collect();
Self::new(data_type, values, Some(Bitmap::new_zeroed(length)))
} else {
panic!("StructArray must be initialized with DataType::Struct");
}
}
}
impl StructArray {
#[must_use]
pub fn into_data(self) -> (Vec<Field>, Vec<Arc<dyn Array>>, Option<Bitmap>) {
let Self {
data_type,
values,
validity,
} = self;
let fields = if let DataType::Struct(fields) = data_type {
fields
} else {
unreachable!()
};
(fields, values, validity)
}
#[must_use]
pub fn slice(&self, offset: usize, length: usize) -> Self {
assert!(
offset + length <= self.len(),
"offset + length may not exceed length of array"
);
unsafe { self.slice_unchecked(offset, length) }
}
#[must_use]
pub unsafe fn slice_unchecked(&self, offset: usize, length: usize) -> Self {
let validity = self
.validity
.clone()
.map(|x| x.slice_unchecked(offset, length));
Self {
data_type: self.data_type.clone(),
values: self
.values
.iter()
.map(|x| x.slice_unchecked(offset, length).into())
.collect(),
validity,
}
}
#[must_use]
pub fn with_validity(&self, validity: Option<Bitmap>) -> Self {
if matches!(&validity, Some(bitmap) if bitmap.len() != self.len()) {
panic!("validity should be as least as large as the array")
}
let mut arr = self.clone();
arr.validity = validity;
arr
}
}
impl StructArray {
#[inline]
fn len(&self) -> usize {
self.values[0].len()
}
#[inline]
pub fn validity(&self) -> Option<&Bitmap> {
self.validity.as_ref()
}
pub fn values(&self) -> &[Arc<dyn Array>] {
&self.values
}
pub fn fields(&self) -> &[Field] {
Self::get_fields(&self.data_type)
}
}
impl StructArray {
pub(crate) fn try_get_fields(data_type: &DataType) -> Result<&[Field], ArrowError> {
match data_type.to_logical_type() {
DataType::Struct(fields) => Ok(fields),
_ => Err(ArrowError::oos(
"Struct array must be created with a DataType whose physical type is Struct",
)),
}
}
pub fn get_fields(data_type: &DataType) -> &[Field] {
Self::try_get_fields(data_type).unwrap()
}
}
impl Array for StructArray {
#[inline]
fn as_any(&self) -> &dyn std::any::Any {
self
}
#[inline]
fn len(&self) -> usize {
self.len()
}
#[inline]
fn data_type(&self) -> &DataType {
&self.data_type
}
#[inline]
fn validity(&self) -> Option<&Bitmap> {
self.validity.as_ref()
}
fn slice(&self, offset: usize, length: usize) -> Box<dyn Array> {
Box::new(self.slice(offset, length))
}
unsafe fn slice_unchecked(&self, offset: usize, length: usize) -> Box<dyn Array> {
Box::new(self.slice_unchecked(offset, length))
}
fn with_validity(&self, validity: Option<Bitmap>) -> Box<dyn Array> {
Box::new(self.with_validity(validity))
}
}