Struct datafusion_expr::expr_fn::SimpleScalarUDF

pub struct SimpleScalarUDF { /* private fields */ }

Implements ScalarUDFImpl for functions that have a single signature and return type.

Implementations

impl SimpleScalarUDF

pub fn new( name: impl Into<String>, input_types: Vec<DataType>, return_type: DataType, volatility: Volatility, fun: ScalarFunctionImplementation ) -> Self

Create a new SimpleScalarUDF from a name, input types, return type and implementation. Implementing ScalarUDFImpl allows more flexibility

Trait Implementations

impl Debug for SimpleScalarUDF

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

Formats the value using the given formatter.

impl ScalarUDFImpl for SimpleScalarUDF

fn as_any(&self) -> &dyn Any

Returns this object as an Any trait object

fn name(&self) -> &str

Returns this function’s name

fn signature(&self) -> &Signature

Returns the function’s Signature for information about what input types are accepted and the function’s Volatility.

fn return_type(&self, _arg_types: &[DataType]) -> Result<DataType>

What [DataType] will be returned by this function, given the types of the arguments

fn invoke(&self, args: &[ColumnarValue]) -> Result<ColumnarValue>

Invoke the function on args, returning the appropriate result

fn aliases(&self) -> &[String]

Returns any aliases (alternate names) for this function.

fn monotonicity(&self) -> Result<Option<FuncMonotonicity>>

This function specifies monotonicity behaviors for User defined scalar functions.