vortex_array/builders/
null.rs

1// SPDX-License-Identifier: Apache-2.0
2// SPDX-FileCopyrightText: Copyright the Vortex contributors
3
4use std::any::Any;
5
6use vortex_error::VortexResult;
7use vortex_error::vortex_ensure;
8use vortex_mask::Mask;
9
10use crate::Array;
11use crate::ArrayRef;
12use crate::IntoArray;
13use crate::arrays::NullArray;
14use crate::builders::ArrayBuilder;
15use crate::canonical::Canonical;
16use crate::dtype::DType;
17use crate::scalar::Scalar;
18
19/// The builder for building a [`NullArray`].
20pub struct NullBuilder {
21    length: usize,
22}
23
24impl Default for NullBuilder {
25    fn default() -> Self {
26        Self::new()
27    }
28}
29
30impl NullBuilder {
31    pub fn new() -> Self {
32        Self { length: 0 }
33    }
34}
35
36impl ArrayBuilder for NullBuilder {
37    fn as_any(&self) -> &dyn Any {
38        self
39    }
40
41    fn as_any_mut(&mut self) -> &mut dyn Any {
42        self
43    }
44
45    fn dtype(&self) -> &DType {
46        &DType::Null
47    }
48
49    fn len(&self) -> usize {
50        self.length
51    }
52
53    fn append_zeros(&mut self, n: usize) {
54        self.length += n;
55    }
56
57    unsafe fn append_nulls_unchecked(&mut self, n: usize) {
58        self.length += n;
59    }
60
61    fn append_scalar(&mut self, scalar: &Scalar) -> VortexResult<()> {
62        vortex_ensure!(
63            scalar.dtype() == self.dtype(),
64            "NullBuilder expected scalar with dtype {}, got {}",
65            self.dtype(),
66            scalar.dtype()
67        );
68
69        self.append_null();
70        Ok(())
71    }
72
73    unsafe fn extend_from_array_unchecked(&mut self, array: &dyn Array) {
74        self.append_nulls(array.len());
75    }
76
77    fn reserve_exact(&mut self, _additional: usize) {}
78
79    unsafe fn set_validity_unchecked(&mut self, _validity: Mask) {}
80
81    fn finish(&mut self) -> ArrayRef {
82        NullArray::new(self.length).into_array()
83    }
84
85    fn finish_into_canonical(&mut self) -> Canonical {
86        Canonical::Null(NullArray::new(self.length))
87    }
88}
89
90#[cfg(test)]
91mod tests {
92    use super::*;
93    use crate::builders::ArrayBuilder;
94    use crate::dtype::DType;
95    use crate::scalar::Scalar;
96
97    #[test]
98    fn test_append_scalar() {
99        let mut builder = NullBuilder::new();
100
101        // Test appending null scalar.
102        let null_scalar = Scalar::null(DType::Null);
103        builder.append_scalar(&null_scalar).unwrap();
104        builder.append_scalar(&null_scalar).unwrap();
105        builder.append_scalar(&null_scalar).unwrap();
106
107        let array = builder.finish();
108        assert_eq!(array.len(), 3);
109
110        // For null arrays, all values are null - nothing to check for actual values.
111        // Just verify the array is indeed a null array with the right length.
112
113        // Test wrong dtype error.
114        let mut builder = NullBuilder::new();
115        let wrong_scalar = Scalar::from(42i32);
116        assert!(builder.append_scalar(&wrong_scalar).is_err());
117    }
118}
vortex_array/builders/null.rs

vortex_array/builders/
null.rs
