Struct UserDefinedFunction

pub struct UserDefinedFunction {
    pub name: PlSmallStr,
    pub return_type: SpecialEq<Arc<dyn FunctionOutputField>>,
    pub fun: LazySerde<SpecialEq<Arc<dyn ColumnsUdf>>>,
    pub options: FunctionOptions,
}

Available on crate feature lazy only.

Represents a user-defined function

Fields

name: PlSmallStr

name

return_type: SpecialEq<Arc<dyn FunctionOutputField>>

The function output type.

fun: LazySerde<SpecialEq<Arc<dyn ColumnsUdf>>>

The function implementation.

options: FunctionOptions

Options for the function.

Implementations

impl UserDefinedFunction

pub fn new( name: PlSmallStr, return_type: SpecialEq<Arc<dyn FunctionOutputField>>, fun: impl ColumnsUdf + 'static, ) -> UserDefinedFunction

Create a new UserDefinedFunction

pub fn call(self, args: Vec<Expr>) -> Expr

creates a logical expression with a call of the UDF

Trait Implementations

impl Clone for UserDefinedFunction

fn clone(&self) -> UserDefinedFunction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UserDefinedFunction

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

Formats the value using the given formatter.