vortex_array/arrays/primitive/
serde.rs

1// SPDX-License-Identifier: Apache-2.0
2// SPDX-FileCopyrightText: Copyright the Vortex contributors
3
4use vortex_buffer::{Alignment, Buffer, ByteBuffer};
5use vortex_dtype::{DType, PType, match_each_native_ptype};
6use vortex_error::{VortexResult, vortex_bail};
7
8use super::PrimitiveEncoding;
9use crate::arrays::{PrimitiveArray, PrimitiveVTable};
10use crate::serde::ArrayChildren;
11use crate::validity::Validity;
12use crate::vtable::{SerdeVTable, ValidityHelper, VisitorVTable};
13use crate::{ArrayBufferVisitor, ArrayChildVisitor, EmptyMetadata};
14
15impl SerdeVTable<PrimitiveVTable> for PrimitiveVTable {
16    type Metadata = EmptyMetadata;
17
18    fn metadata(_array: &PrimitiveArray) -> VortexResult<Option<Self::Metadata>> {
19        Ok(Some(EmptyMetadata))
20    }
21
22    fn build(
23        _encoding: &PrimitiveEncoding,
24        dtype: &DType,
25        len: usize,
26        _metadata: &Self::Metadata,
27        buffers: &[ByteBuffer],
28        children: &dyn ArrayChildren,
29    ) -> VortexResult<PrimitiveArray> {
30        if buffers.len() != 1 {
31            vortex_bail!("Expected 1 buffer, got {}", buffers.len());
32        }
33        let buffer = buffers[0].clone();
34
35        let validity = if children.is_empty() {
36            Validity::from(dtype.nullability())
37        } else if children.len() == 1 {
38            let validity = children.get(0, &Validity::DTYPE, len)?;
39            Validity::Array(validity)
40        } else {
41            vortex_bail!("Expected 0 or 1 child, got {}", children.len());
42        };
43
44        let ptype = PType::try_from(dtype)?;
45
46        if !buffer.is_aligned(Alignment::new(ptype.byte_width())) {
47            vortex_bail!(
48                "Buffer is not aligned to {}-byte boundary",
49                ptype.byte_width()
50            );
51        }
52        if buffer.len() != ptype.byte_width() * len {
53            vortex_bail!(
54                "Buffer length {} does not match expected length {} for {}, {}",
55                buffer.len(),
56                ptype.byte_width() * len,
57                ptype.byte_width(),
58                len,
59            );
60        }
61
62        match_each_native_ptype!(ptype, |P| {
63            let buffer = Buffer::<P>::from_byte_buffer(buffer);
64            Ok(PrimitiveArray::new(buffer, validity))
65        })
66    }
67}
68
69impl VisitorVTable<PrimitiveVTable> for PrimitiveVTable {
70    fn visit_buffers(array: &PrimitiveArray, visitor: &mut dyn ArrayBufferVisitor) {
71        visitor.visit_buffer(array.byte_buffer());
72    }
73
74    fn visit_children(array: &PrimitiveArray, visitor: &mut dyn ArrayChildVisitor) {
75        visitor.visit_validity(array.validity(), array.len());
76    }
77}