Struct FunctionOptions 

pub struct FunctionOptions {
    pub call_mode: CallMode,
    pub is_async: bool,
    pub is_batched: bool,
    pub handler: Option<String>,
}

Options for configuring user-defined functions.

Fields

call_mode: CallMode

Whether the function will be called when some of its arguments are null.

is_async: bool

Whether the function is async. An async function would return a Promise.

is_batched: bool

Whether the function accepts a batch of records as input.

handler: Option<String>

The name of the function in JavaScript code to be called. If not set, the function name will be used.

Implementations

impl FunctionOptions

pub fn return_null_on_null_input(self) -> Self

Sets the function to return null when some of its arguments are null. See CallMode for more details.

pub fn async_mode(self) -> Self

Marks the function to be async JS function.

pub fn batched(self) -> Self

Sets the function to accept a batch of records as input.

pub fn handler(self, handler: impl Into<String>) -> Self

Sets the name of the function in JavaScript code to be called.

Trait Implementations

impl Clone for FunctionOptions

fn clone(&self) -> FunctionOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FunctionOptions

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

Formats the value using the given formatter.

impl Default for FunctionOptions

fn default() -> FunctionOptions

Returns the “default value” for a type.