vortex_array/arrays/varbinview/vtable/
mod.rs

1// SPDX-License-Identifier: Apache-2.0
2// SPDX-FileCopyrightText: Copyright the Vortex contributors
3
4use std::sync::Arc;
5
6use vortex_buffer::Buffer;
7use vortex_buffer::ByteBuffer;
8use vortex_dtype::DType;
9use vortex_error::VortexExpect;
10use vortex_error::VortexResult;
11use vortex_error::vortex_bail;
12use vortex_error::vortex_err;
13use vortex_vector::Vector;
14use vortex_vector::binaryview::BinaryVector;
15use vortex_vector::binaryview::BinaryView;
16use vortex_vector::binaryview::StringVector;
17
18use crate::ArrayRef;
19use crate::EmptyMetadata;
20use crate::arrays::varbinview::VarBinViewArray;
21use crate::buffer::BufferHandle;
22use crate::executor::ExecutionCtx;
23use crate::serde::ArrayChildren;
24use crate::validity::Validity;
25use crate::vtable;
26use crate::vtable::ArrayId;
27use crate::vtable::ArrayVTable;
28use crate::vtable::ArrayVTableExt;
29use crate::vtable::NotSupported;
30use crate::vtable::VTable;
31use crate::vtable::ValidityVTableFromValidityHelper;
32
33mod array;
34mod canonical;
35mod operations;
36mod validity;
37mod visitor;
38
39vtable!(VarBinView);
40
41#[derive(Debug)]
42pub struct VarBinViewVTable;
43
44impl VTable for VarBinViewVTable {
45    type Array = VarBinViewArray;
46
47    type Metadata = EmptyMetadata;
48
49    type ArrayVTable = Self;
50    type CanonicalVTable = Self;
51    type OperationsVTable = Self;
52    type ValidityVTable = ValidityVTableFromValidityHelper;
53    type VisitorVTable = Self;
54    type ComputeVTable = NotSupported;
55    type EncodeVTable = NotSupported;
56
57    fn id(&self) -> ArrayId {
58        ArrayId::new_ref("vortex.varbinview")
59    }
60
61    fn encoding(_array: &Self::Array) -> ArrayVTable {
62        VarBinViewVTable.as_vtable()
63    }
64
65    fn metadata(_array: &VarBinViewArray) -> VortexResult<Self::Metadata> {
66        Ok(EmptyMetadata)
67    }
68
69    fn serialize(_metadata: Self::Metadata) -> VortexResult<Option<Vec<u8>>> {
70        Ok(Some(vec![]))
71    }
72
73    fn deserialize(_buffer: &[u8]) -> VortexResult<Self::Metadata> {
74        Ok(EmptyMetadata)
75    }
76
77    fn build(
78        &self,
79        dtype: &DType,
80        len: usize,
81        _metadata: &Self::Metadata,
82        buffers: &[BufferHandle],
83        children: &dyn ArrayChildren,
84    ) -> VortexResult<VarBinViewArray> {
85        if buffers.is_empty() {
86            vortex_bail!("Expected at least 1 buffer, got {}", buffers.len());
87        }
88        let mut buffers: Vec<ByteBuffer> = buffers
89            .iter()
90            .map(|b| b.clone().try_to_bytes())
91            .collect::<VortexResult<Vec<_>>>()?;
92        let views = buffers.pop().vortex_expect("buffers non-empty");
93
94        let views = Buffer::<BinaryView>::from_byte_buffer(views);
95
96        if views.len() != len {
97            vortex_bail!("Expected {} views, got {}", len, views.len());
98        }
99
100        let validity = if children.is_empty() {
101            Validity::from(dtype.nullability())
102        } else if children.len() == 1 {
103            let validity = children.get(0, &Validity::DTYPE, len)?;
104            Validity::Array(validity)
105        } else {
106            vortex_bail!("Expected 0 or 1 children, got {}", children.len());
107        };
108
109        VarBinViewArray::try_new(views, Arc::from(buffers), dtype.clone(), validity)
110    }
111
112    fn with_children(array: &mut Self::Array, children: Vec<ArrayRef>) -> VortexResult<()> {
113        match children.len() {
114            0 => {}
115            1 => {
116                let [validity]: [ArrayRef; 1] = children
117                    .try_into()
118                    .map_err(|_| vortex_err!("Failed to convert children to array"))?;
119                array.validity = Validity::Array(validity);
120            }
121            _ => vortex_bail!(
122                "VarBinViewArray expects 0 or 1 children (validity?), got {}",
123                children.len()
124            ),
125        }
126        Ok(())
127    }
128
129    fn execute(array: &Self::Array, _ctx: &mut ExecutionCtx) -> VortexResult<Vector> {
130        Ok(match array.dtype() {
131            DType::Utf8(_) => unsafe {
132                StringVector::new_unchecked(
133                    array.views().clone(),
134                    Arc::new(array.buffers().to_vec().into_boxed_slice()),
135                    array.validity_mask(),
136                )
137                .into()
138            },
139            DType::Binary(_) => unsafe {
140                BinaryVector::new_unchecked(
141                    array.views().clone(),
142                    Arc::new(array.buffers().to_vec().into_boxed_slice()),
143                    array.validity_mask(),
144                )
145                .into()
146            },
147            _ => unreachable!("VarBinViewArray must have Binary or Utf8 dtype"),
148        })
149    }
150}
vortex_array/arrays/varbinview/vtable/mod.rs

vortex_array/arrays/varbinview/vtable/
mod.rs
