Struct FfiInitData 

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

Type-safe global init data for DuckDB table functions.

Set in the global init callback; retrieved in scan.

Implementations

impl<T: 'static> FfiInitData<T>

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

Stores data as the global init data for this query.

Call inside your global init callback.

Safety

• info must be a valid duckdb_init_info.
• Must be called at most once per init invocation.

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

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

Returns None if no init data was set.

Safety

• info must be a valid duckdb_function_info from a scan callback.
• No mutable reference to the same data must exist simultaneously.

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

Retrieves a mutable reference to the global init data from a scan callback.

Returns None if no init data was set.

Safety

• info must be a valid duckdb_function_info from a scan callback.
• No other reference to the same data must exist simultaneously.

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

Destroy callback: drops the Box<T>.

Safety

ptr must have been allocated by set.