vortex-array 0.84.0

Vortex in memory columnar data format
Documentation 
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

// SPDX-License-Identifier: Apache-2.0
// SPDX-FileCopyrightText: Copyright the Vortex contributors

use crate::scalar_fn::Arity;
use crate::scalar_fn::ChildName;
use crate::scalar_fn::typed::DynScalarFn;

/// Information about the signature of an expression.
pub struct ScalarFnSignature<'a> {
    pub(super) inner: &'a dyn DynScalarFn,
}

impl ScalarFnSignature<'_> {
    /// Returns the arity of this expression.
    pub fn arity(&self) -> Arity {
        self.inner.arity()
    }

    /// Returns the name of the nth child of this expression.
    pub fn child_name(&self, index: usize) -> ChildName {
        self.inner.child_name(index)
    }

    /// Returns whether this expression itself is strict.
    /// See [`crate::scalar_fn::ScalarFnVTable::is_strict`].
    pub fn is_strict(&self) -> bool {
        self.inner.is_strict()
    }

    /// Returns whether this expression itself is fallible.
    /// See [`crate::scalar_fn::ScalarFnVTable::is_fallible`].
    pub fn is_fallible(&self) -> bool {
        self.inner.is_fallible()
    }
}