Struct polars::prelude::udf::UserDefinedFunction

pub struct UserDefinedFunction {
    pub name: String,
    pub input_fields: Vec<Field>,
    pub return_type: SpecialEq<Arc<dyn FunctionOutputField>>,
    pub fun: SpecialEq<Arc<dyn SeriesUdf>>,
    pub options: FunctionOptions,
}

Available on crate feature lazy only.

Represents a user-defined function

Fields

name: String

name

input_fields: Vec<Field>

The function signature.

return_type: SpecialEq<Arc<dyn FunctionOutputField>>

The function output type.

fun: SpecialEq<Arc<dyn SeriesUdf>>

The function implementation.

options: FunctionOptions

Options for the function.

Implementations

impl UserDefinedFunction

pub fn new( name: &str, input_fields: Vec<Field>, return_type: SpecialEq<Arc<dyn FunctionOutputField>>, fun: impl SeriesUdf + 'static ) -> UserDefinedFunction

Create a new UserDefinedFunction

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

creates a logical expression with a call of the UDF This utility allows using the UDF without requiring access to the registry. The schema is validated and the query will fail if the schema is invalid.

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

creates a logical expression with a call of the UDF This does not do any schema validation and is therefore faster.

Only use this if you are certain that the schema is correct. If the schema is invalid, the query will fail at runtime.

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.