Struct FFI_WindowUDF 

#[repr(C)]
pub struct FFI_WindowUDF {
    pub name: String,
    pub aliases: Vec<String>,
    pub volatility: FFI_Volatility,
    pub partition_evaluator: unsafe extern "C" fn(udwf: &Self, args: FFI_PartitionEvaluatorArgs) -> FFI_Result<FFI_PartitionEvaluator>,
    pub field: unsafe extern "C" fn(udwf: &Self, input_types: Vec<WrappedSchema>, display_name: String) -> FFI_Result<WrappedSchema>,
    pub coerce_types: unsafe extern "C" fn(udf: &Self, arg_types: Vec<WrappedSchema>) -> FFI_Result<Vec<WrappedSchema>>,
    pub sort_options: FFI_Option<FFI_SortOptions>,
    pub clone: unsafe extern "C" fn(udf: &Self) -> Self,
    pub release: unsafe extern "C" fn(udf: &mut Self),
    pub private_data: *mut c_void,
    pub library_marker_id: extern "C" fn() -> usize,
}

A stable struct for sharing a WindowUDF across FFI boundaries.

Fields

name: String

FFI equivalent to the name of a WindowUDF

aliases: Vec<String>

FFI equivalent to the aliases of a WindowUDF

volatility: FFI_Volatility

FFI equivalent to the volatility of a WindowUDF

partition_evaluator: unsafe extern "C" fn(udwf: &Self, args: FFI_PartitionEvaluatorArgs) -> FFI_Result<FFI_PartitionEvaluator>

field: unsafe extern "C" fn(udwf: &Self, input_types: Vec<WrappedSchema>, display_name: String) -> FFI_Result<WrappedSchema>

coerce_types: unsafe extern "C" fn(udf: &Self, arg_types: Vec<WrappedSchema>) -> FFI_Result<Vec<WrappedSchema>>

Performs type coercion. To simply this interface, all UDFs are treated as having user defined signatures, which will in turn call coerce_types to be called. This call should be transparent to most users as the internal function performs the appropriate calls on the underlying WindowUDF

sort_options: FFI_Option<FFI_SortOptions>

clone: unsafe extern "C" fn(udf: &Self) -> Self

Used to create a clone on the provider of the udf. This should only need to be called by the receiver of the udf.

release: unsafe extern "C" fn(udf: &mut Self)

Release the memory of the private data when it is no longer being used.

private_data: *mut c_void

Internal data. This is only to be accessed by the provider of the udf. A ForeignWindowUDF should never attempt to access this data.

library_marker_id: extern "C" fn() -> usize

Utility to identify when FFI objects are accessed locally through the foreign interface. See crate::get_library_marker_id and the crate’s README.md for more information.

Trait Implementations

impl Clone for FFI_WindowUDF

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FFI_WindowUDF

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

Formats the value using the given formatter.

impl Drop for FFI_WindowUDF

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl From<&FFI_WindowUDF> for Arc<dyn WindowUDFImpl>

fn from(udf: &FFI_WindowUDF) -> Self

Converts to this type from the input type.

impl From<Arc<WindowUDF>> for FFI_WindowUDF

fn from(udf: Arc<WindowUDF>) -> Self

Converts to this type from the input type.

impl Send for FFI_WindowUDF

impl Sync for FFI_WindowUDF