Struct ForeignWindowUDF 

pub struct ForeignWindowUDF { /* private fields */ }

This struct is used to access an UDF provided by a foreign library across a FFI boundary.

The ForeignWindowUDF is to be used by the caller of the UDF, so it has no knowledge or access to the private data. All interaction with the UDF must occur through the functions defined in FFI_WindowUDF.

Trait Implementations

impl Debug for ForeignWindowUDF

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

Formats the value using the given formatter.

impl Eq for ForeignWindowUDF

impl Hash for ForeignWindowUDF

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ForeignWindowUDF

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Send for ForeignWindowUDF

impl Sync for ForeignWindowUDF

impl WindowUDFImpl for ForeignWindowUDF

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 aliases(&self) -> &[String]

Returns any aliases (alternate names) for this function.

fn coerce_types(&self, arg_types: &[DataType]) -> Result<Vec<DataType>>

Coerce arguments of a function call to types that the function can evaluate.

fn partition_evaluator( &self, args: PartitionEvaluatorArgs<'_>, ) -> Result<Box<dyn PartitionEvaluator>>

Invoke the function, returning the PartitionEvaluator instance

fn field(&self, field_args: WindowUDFFieldArgs<'_>) -> Result<FieldRef>

The FieldRef of the final result of evaluating this window function.

fn sort_options(&self) -> Option<SortOptions>

Allows the window UDF to define a custom result ordering.

fn limit_effect(&self, _args: &[Arc<dyn PhysicalExpr>]) -> LimitEffect

If not causal, returns the effect this function will have on the window

fn expressions( &self, expr_args: ExpressionArgs<'_>, ) -> Vec<Arc<dyn PhysicalExpr>>

Returns the expressions that are passed to the PartitionEvaluator.

fn simplify( &self, ) -> Option<Box<dyn Fn(WindowFunction, &SimplifyContext) -> Result<Expr, DataFusionError>>>

Returns an optional hook for simplifying this user-defined window function.

fn reverse_expr(&self) -> ReversedUDWF

Allows customizing the behavior of the user-defined window function when it is evaluated in reverse order.

fn documentation(&self) -> Option<&Documentation>

Returns the documentation for this Window UDF.