Struct FFI_AggregateUDF 

#[repr(C)]
pub struct FFI_AggregateUDF {

    pub name: String,
    pub aliases: Vec<String>,
    pub volatility: FFI_Volatility,
    pub return_field: unsafe extern "C" fn(udaf: &Self, arg_fields: Vec<WrappedSchema>) -> FFI_Result<WrappedSchema>,
    pub is_nullable: bool,
    pub groups_accumulator_supported: unsafe extern "C" fn(udaf: &FFI_AggregateUDF, args: FFI_AccumulatorArgs) -> bool,
    pub accumulator: unsafe extern "C" fn(udaf: &FFI_AggregateUDF, args: FFI_AccumulatorArgs) -> FFI_Result<FFI_Accumulator>,
    pub create_sliding_accumulator: unsafe extern "C" fn(udaf: &FFI_AggregateUDF, args: FFI_AccumulatorArgs) -> FFI_Result<FFI_Accumulator>,
    pub state_fields: unsafe extern "C" fn(udaf: &FFI_AggregateUDF, name: &Str<'_>, input_fields: Vec<WrappedSchema>, return_field: WrappedSchema, ordering_fields: Vec<Vec<u8>>, is_distinct: bool) -> FFI_Result<Vec<Vec<u8>>>,
    pub create_groups_accumulator: unsafe extern "C" fn(udaf: &FFI_AggregateUDF, args: FFI_AccumulatorArgs) -> FFI_Result<FFI_GroupsAccumulator>,
    pub with_beneficial_ordering: unsafe extern "C" fn(udaf: &FFI_AggregateUDF, beneficial_ordering: bool) -> FFI_Result<FFI_Option<FFI_AggregateUDF>>,
    pub order_sensitivity: unsafe extern "C" fn(udaf: &FFI_AggregateUDF) -> FFI_AggregateOrderSensitivity,
    pub coerce_types: unsafe extern "C" fn(udf: &Self, arg_types: Vec<WrappedSchema>) -> FFI_Result<Vec<WrappedSchema>>,
    pub clone: unsafe extern "C" fn(udaf: &Self) -> Self,
    pub release: unsafe extern "C" fn(udaf: &mut Self),
    pub private_data: *mut c_void,
    pub library_marker_id: extern "C" fn() -> usize,
}

A stable struct for sharing a AggregateUDF across FFI boundaries.

Fields

name: String

FFI equivalent to the name of a AggregateUDF

aliases: Vec<String>

FFI equivalent to the aliases of a AggregateUDF

volatility: FFI_Volatility

FFI equivalent to the volatility of a AggregateUDF

return_field: unsafe extern "C" fn(udaf: &Self, arg_fields: Vec<WrappedSchema>) -> FFI_Result<WrappedSchema>

Determines the return field of the underlying AggregateUDF based on the argument fields.

is_nullable: bool

FFI equivalent to the is_nullable of a AggregateUDF

groups_accumulator_supported: unsafe extern "C" fn(udaf: &FFI_AggregateUDF, args: FFI_AccumulatorArgs) -> bool

FFI equivalent to AggregateUDF::groups_accumulator_supported

accumulator: unsafe extern "C" fn(udaf: &FFI_AggregateUDF, args: FFI_AccumulatorArgs) -> FFI_Result<FFI_Accumulator>

FFI equivalent to AggregateUDF::accumulator

create_sliding_accumulator: unsafe extern "C" fn(udaf: &FFI_AggregateUDF, args: FFI_AccumulatorArgs) -> FFI_Result<FFI_Accumulator>

FFI equivalent to AggregateUDF::create_sliding_accumulator

state_fields: unsafe extern "C" fn(udaf: &FFI_AggregateUDF, name: &Str<'_>, input_fields: Vec<WrappedSchema>, return_field: WrappedSchema, ordering_fields: Vec<Vec<u8>>, is_distinct: bool) -> FFI_Result<Vec<Vec<u8>>>

FFI equivalent to AggregateUDF::state_fields

create_groups_accumulator: unsafe extern "C" fn(udaf: &FFI_AggregateUDF, args: FFI_AccumulatorArgs) -> FFI_Result<FFI_GroupsAccumulator>

FFI equivalent to AggregateUDF::create_groups_accumulator

with_beneficial_ordering: unsafe extern "C" fn(udaf: &FFI_AggregateUDF, beneficial_ordering: bool) -> FFI_Result<FFI_Option<FFI_AggregateUDF>>

FFI equivalent to AggregateUDF::with_beneficial_ordering

order_sensitivity: unsafe extern "C" fn(udaf: &FFI_AggregateUDF) -> FFI_AggregateOrderSensitivity

FFI equivalent to AggregateUDF::order_sensitivity

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 AggregateUDF

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

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

release: unsafe extern "C" fn(udaf: &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 udaf. A ForeignAggregateUDF 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_AggregateUDF

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_AggregateUDF

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

Formats the value using the given formatter.

impl Drop for FFI_AggregateUDF

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_AggregateUDF> for Arc<dyn AggregateUDFImpl>

fn from(udaf: &FFI_AggregateUDF) -> Self

Converts to this type from the input type.

impl From<Arc<AggregateUDF>> for FFI_AggregateUDF

fn from(udaf: Arc<AggregateUDF>) -> Self

Converts to this type from the input type.

impl Send for FFI_AggregateUDF

impl Sync for FFI_AggregateUDF