risingwave_expr/expr/
value.rs

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
// Copyright 2024 RisingWave Labs
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use either::Either;
use risingwave_common::array::*;
use risingwave_common::for_all_variants;
use risingwave_common::types::{Datum, DatumRef, Scalar, ToDatumRef};

/// The type-erased return value of an expression.
///
/// It can be either an array, or a scalar if all values in the array are the same.
#[derive(Debug, Clone)]
pub enum ValueImpl {
    Array(ArrayRef),
    Scalar { value: Datum, capacity: usize },
}

impl From<ArrayRef> for ValueImpl {
    fn from(value: ArrayRef) -> Self {
        Self::Array(value)
    }
}

impl ValueImpl {
    /// Number of scalars in this value.
    #[inline]
    #[expect(clippy::len_without_is_empty)]
    pub fn len(&self) -> usize {
        self.iter().len()
    }

    /// Iterates over all scalars in this value.
    pub fn iter(&self) -> impl ExactSizeIterator<Item = DatumRef<'_>> + '_ {
        match self {
            Self::Array(array) => Either::Left(array.iter()),
            Self::Scalar { value, capacity } => {
                Either::Right(itertools::repeat_n(value.to_datum_ref(), *capacity))
            }
        }
    }
}

/// The generic reference type of [`ValueImpl`]. Used as the arguments of expressions.
#[derive(Debug, Clone, Copy)]
pub enum ValueRef<'a, A: Array> {
    Array(&'a A),
    Scalar {
        value: Option<<A as Array>::RefItem<'a>>,
        capacity: usize,
    },
}

impl<'a, A: Array> ValueRef<'a, A> {
    /// Number of scalars in this value.
    #[inline]
    #[expect(clippy::len_without_is_empty)]
    pub fn len(self) -> usize {
        self.iter().len()
    }

    /// Iterates over all scalars in this value.
    pub fn iter(self) -> impl ExactSizeIterator<Item = Option<A::RefItem<'a>>> + 'a {
        match self {
            Self::Array(array) => Either::Left(array.iter()),
            Self::Scalar { value, capacity } => Either::Right(itertools::repeat_n(value, capacity)),
        }
    }
}

macro_rules! impl_convert {
    ($( { $data_type:ident, $variant_name:ident, $suffix_name:ident, $scalar:ty, $scalar_ref:ty, $array:ty, $builder:ty } ),*) => {
        $(
            paste::paste! {
                /// Converts a type-erased value to a reference of a specific array type.
                impl<'a> From<&'a ValueImpl> for ValueRef<'a, $array> {
                    fn from(value: &'a ValueImpl) -> Self {
                        match value {
                            ValueImpl::Array(array) => {
                                let array = array.[<as_ $suffix_name>]();
                                ValueRef::Array(array)
                            },
                            ValueImpl::Scalar { value, capacity } => {
                                let value = value.as_ref().map(|v| v.[<as_ $suffix_name>]().as_scalar_ref());
                                ValueRef::Scalar { value, capacity: *capacity }
                            },
                        }
                    }
                }
            }
        )*
    };
}

for_all_variants! { impl_convert }