vortex_array/arrays/varbin/vtable/
mod.rs

1// SPDX-License-Identifier: Apache-2.0
2// SPDX-FileCopyrightText: Copyright the Vortex contributors
3
4use vortex_buffer::BufferHandle;
5use vortex_dtype::DType;
6use vortex_dtype::Nullability;
7use vortex_dtype::PType;
8use vortex_error::VortexExpect;
9use vortex_error::VortexResult;
10use vortex_error::vortex_bail;
11
12use crate::DeserializeMetadata;
13use crate::ProstMetadata;
14use crate::SerializeMetadata;
15use crate::arrays::varbin::VarBinArray;
16use crate::serde::ArrayChildren;
17use crate::validity::Validity;
18use crate::vtable;
19use crate::vtable::ArrayId;
20use crate::vtable::ArrayVTable;
21use crate::vtable::ArrayVTableExt;
22use crate::vtable::NotSupported;
23use crate::vtable::VTable;
24use crate::vtable::ValidityVTableFromValidityHelper;
25
26mod array;
27mod canonical;
28mod operations;
29mod validity;
30mod visitor;
31
32vtable!(VarBin);
33
34#[derive(Clone, prost::Message)]
35pub struct VarBinMetadata {
36    #[prost(enumeration = "PType", tag = "1")]
37    pub(crate) offsets_ptype: i32,
38}
39
40impl VTable for VarBinVTable {
41    type Array = VarBinArray;
42
43    type Metadata = ProstMetadata<VarBinMetadata>;
44
45    type ArrayVTable = Self;
46    type CanonicalVTable = Self;
47    type OperationsVTable = Self;
48    type ValidityVTable = ValidityVTableFromValidityHelper;
49    type VisitorVTable = Self;
50    type ComputeVTable = NotSupported;
51    type EncodeVTable = NotSupported;
52
53    fn id(&self) -> ArrayId {
54        ArrayId::new_ref("vortex.varbin")
55    }
56
57    fn encoding(_array: &Self::Array) -> ArrayVTable {
58        VarBinVTable.as_vtable()
59    }
60
61    fn metadata(array: &VarBinArray) -> VortexResult<Self::Metadata> {
62        Ok(ProstMetadata(VarBinMetadata {
63            offsets_ptype: PType::try_from(array.offsets().dtype())
64                .vortex_expect("Must be a valid PType") as i32,
65        }))
66    }
67
68    fn serialize(metadata: Self::Metadata) -> VortexResult<Option<Vec<u8>>> {
69        Ok(Some(metadata.serialize()))
70    }
71
72    fn deserialize(bytes: &[u8]) -> VortexResult<Self::Metadata> {
73        Ok(ProstMetadata(ProstMetadata::<VarBinMetadata>::deserialize(
74            bytes,
75        )?))
76    }
77
78    fn build(
79        &self,
80        dtype: &DType,
81        len: usize,
82        metadata: &Self::Metadata,
83        buffers: &[BufferHandle],
84        children: &dyn ArrayChildren,
85    ) -> VortexResult<VarBinArray> {
86        let validity = if children.len() == 1 {
87            Validity::from(dtype.nullability())
88        } else if children.len() == 2 {
89            let validity = children.get(1, &Validity::DTYPE, len)?;
90            Validity::Array(validity)
91        } else {
92            vortex_bail!("Expected 1 or 2 children, got {}", children.len());
93        };
94
95        let offsets = children.get(
96            0,
97            &DType::Primitive(metadata.offsets_ptype(), Nullability::NonNullable),
98            len + 1,
99        )?;
100
101        if buffers.len() != 1 {
102            vortex_bail!("Expected 1 buffer, got {}", buffers.len());
103        }
104        let bytes = buffers[0].clone().try_to_bytes()?;
105
106        VarBinArray::try_new(offsets, bytes, dtype.clone(), validity)
107    }
108}
109
110#[derive(Debug)]
111pub struct VarBinVTable;
vortex_array/arrays/varbin/vtable/mod.rs

vortex_array/arrays/varbin/vtable/
mod.rs
