Struct datafusion_expr::ScalarUDF
source · [−]pub struct ScalarUDF {
pub name: String,
pub signature: Signature,
pub return_type: ReturnTypeFunction,
pub fun: ScalarFunctionImplementation,
}
Expand description
Logical representation of a UDF.
Fields
name: String
name
signature: Signature
signature
return_type: ReturnTypeFunction
Return type
fun: ScalarFunctionImplementation
actual implementation
The fn param is the wrapped function but be aware that the function will be passed with the slice / vec of columnar values (either scalar or array) with the exception of zero param function, where a singular element vec will be passed. In that case the single element is a null array to indicate the batch’s row count (so that the generative zero-argument function can know the result array size).
Implementations
sourceimpl ScalarUDF
impl ScalarUDF
sourcepub fn new(
name: &str,
signature: &Signature,
return_type: &ReturnTypeFunction,
fun: &ScalarFunctionImplementation
) -> Self
pub fn new(
name: &str,
signature: &Signature,
return_type: &ReturnTypeFunction,
fun: &ScalarFunctionImplementation
) -> Self
Create a new ScalarUDF
Trait Implementations
Auto Trait Implementations
impl !RefUnwindSafe for ScalarUDF
impl Send for ScalarUDF
impl Sync for ScalarUDF
impl Unpin for ScalarUDF
impl !UnwindSafe for ScalarUDF
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more