Struct FfiBindData 

pub struct FfiBindData<T: 'static> { /* private fields */ }

Type-safe bind data wrapper for DuckDB table functions.

FfiBindData<T> boxes a T on the heap during bind and provides safe access in subsequent phases. DuckDB owns the allocation lifetime and calls the provided destroy callback when the query is done.

Memory model

• set — boxes T via Box::into_raw, registers the pointer and the destroy destructor with DuckDB.
• DuckDB calls destroy when the query completes, which drops the Box<T>.
• Retrieval methods borrow the T for the duration of the callback.

Implementations

impl<T: 'static> FfiBindData<T>

pub unsafe fn set(info: duckdb_bind_info, data: T)

Stores data as the bind data for this table function invocation.

Call this inside your bind callback to save configuration that will be accessed in init and scan callbacks.

Safety

• info must be a valid duckdb_bind_info provided by DuckDB in a bind callback.
• Must be called at most once per bind invocation; calling twice leaks the first allocation.

pub const fn get_from_bind<'a>(info: duckdb_bind_info) -> Option<&'a T>

Retrieves a shared reference to the bind data from a bind callback.

Returns None if no bind data was set or the pointer is null.

Safety

• info must be a valid duckdb_bind_info.
• No mutable reference to the same data must exist.
• The returned reference is valid for the duration of the bind callback.

pub unsafe fn get_from_init<'a>(info: duckdb_init_info) -> Option<&'a T>

Retrieves a shared reference to the bind data from a global init callback.

Returns None if no bind data was set or the pointer is null.

Safety

• info must be a valid duckdb_init_info.
• No mutable reference to the same data must exist simultaneously.
• The returned reference is valid for the duration of the init callback.

pub unsafe fn get_from_function<'a>(info: duckdb_function_info) -> Option<&'a T>

Retrieves a shared reference to the bind data from a scan callback.

Returns None if no bind data was set or the pointer is null.

Safety

• info must be a valid duckdb_function_info from a scan callback.
• No mutable reference to the same data must exist simultaneously.
• The returned reference is valid for the duration of the scan callback.

pub unsafe extern "C" fn destroy(ptr: *mut c_void)

The destroy callback passed to duckdb_bind_set_bind_data.

DuckDB calls this when the query is complete. It drops the Box<T>.

Safety

• ptr must have been allocated by set via Box::into_raw.
• Must be called exactly once (DuckDB guarantees this for bind data destroyers).