Struct FuncSign

pub struct FuncSign {
    pub name: FuncName,
    pub inputs_type: Vec<SigDataType>,
    pub variadic: bool,
    pub ret_type: SigDataType,
    pub build: FuncBuilder,
    pub type_infer: fn(args: &[DataType]) -> Result<DataType>,
    pub deprecated: bool,
}

A function signature.

Fields

name: FuncName

The name of the function.

inputs_type: Vec<SigDataType>

The argument types.

variadic: bool

Whether the function is variadic.

ret_type: SigDataType

The return type.

build: FuncBuilder

A function to build the expression.

type_infer: fn(args: &[DataType]) -> Result<DataType>

A function to infer the return type from argument types.

deprecated: bool

Whether the function is deprecated and should not be used in the frontend. For backward compatibility, it is still available in the backend.

Implementations

impl FuncSign

pub fn match_args(&self, args: &[DataType]) -> bool

Returns true if the argument types match the function signature.

fn match_args_ret(&self, args: &[DataType], ret: &DataType) -> bool

Returns true if the argument types match the function signature.

fn match_number_of_args(&self, n: usize) -> bool

Returns true if the number of arguments matches the function signature.

pub const fn is_scalar(&self) -> bool

Returns true if the function is a scalar function.

pub const fn is_table_function(&self) -> bool

Returns true if the function is a table function.

pub const fn is_aggregate(&self) -> bool

Returns true if the function is a aggregate function.

pub const fn is_append_only(&self) -> bool

Returns true if the aggregate function is append-only.

pub const fn is_retractable(&self) -> bool

Returns true if the aggregate function has a retractable version.

pub fn build_scalar( &self, return_type: DataType, children: Vec<BoxedExpression>, ) -> Result<BoxedExpression>

Builds the scalar function.

pub fn build_table( &self, return_type: DataType, chunk_size: usize, children: Vec<BoxedExpression>, ) -> Result<BoxedTableFunction>

Builds the table function.

pub fn build_aggregate(&self, agg: &AggCall) -> Result<BoxedAggregateFunction>

Builds the aggregate function. If both retractable and append-only versions exist, the retractable version will be built.

Trait Implementations

impl Clone for FuncSign

fn clone(&self) -> FuncSign

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FuncSign

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.