Struct datafusion_expr::expr_fn::SimpleWindowUDF

pub struct SimpleWindowUDF { /* private fields */ }

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

Implementations

impl SimpleWindowUDF

pub fn new( name: impl Into<String>, input_type: DataType, return_type: DataType, volatility: Volatility, partition_evaluator_factory: PartitionEvaluatorFactory, ) -> Self

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

Trait Implementations

impl Debug for SimpleWindowUDF

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

Formats the value using the given formatter.

impl WindowUDFImpl for SimpleWindowUDF

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 partition_evaluator(&self) -> Result<Box<dyn PartitionEvaluator>>

Invoke the function, returning the PartitionEvaluator instance

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

Returns any aliases (alternate names) for this function.

fn simplify(&self) -> Option<WindowFunctionSimplification>

Optionally apply per-UDWF simplification / rewrite rules.

fn equals(&self, other: &dyn WindowUDFImpl) -> bool

Return true if this window UDF is equal to the other.

fn hash_value(&self) -> u64

Returns a hash value for this window UDF.