Struct DfScalarFunction

pub struct DfScalarFunction {
    pub(crate) raw_fn: RawDfScalarFn,
    pub(crate) fn_impl: Arc<dyn PhysicalExpr>,
    pub(crate) df_schema: Arc<DFSchema>,
}

A way to represent a scalar function that is implemented in Datafusion

Fields

raw_fn: RawDfScalarFn

The raw bytes encoded datafusion scalar function

fn_impl: Arc<dyn PhysicalExpr>

The implementation of the function

df_schema: Arc<DFSchema>

The input schema of the function

Implementations

impl DfScalarFunction

pub fn new( raw_fn: RawDfScalarFn, fn_impl: Arc<dyn PhysicalExpr>, ) -> Result<Self, Error>

pub async fn try_from_raw_fn(raw_fn: RawDfScalarFn) -> Result<Self, Error>

pub fn eval_batch( &self, batch: &Batch, exprs: &[ScalarExpr], ) -> Result<VectorRef, EvalError>

Evaluate a batch of expressions using input values

fn eval_args( values: &[Value], exprs: &[ScalarExpr], ) -> Result<Vec<Value>, EvalError>

eval a list of expressions using input values

pub fn eval( &self, values: &[Value], exprs: &[ScalarExpr], ) -> Result<Value, EvalError>

Trait Implementations

impl Clone for DfScalarFunction

fn clone(&self) -> DfScalarFunction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DfScalarFunction

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

Formats the value using the given formatter.

impl Hash for DfScalarFunction

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 Ord for DfScalarFunction

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for DfScalarFunction

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 PartialOrd for DfScalarFunction

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for DfScalarFunction