Struct InitInfo

pub struct InitInfo(/* private fields */);

An interface to store and retrieve data during the function init stage

Implementations

impl InitInfo

pub unsafe fn set_init_data( &self, data: *mut c_void, freeer: Option<unsafe extern "C" fn(*mut c_void)>, )

Safety

pub fn get_column_indices(&self) -> Vec<idx_t>

Returns the column indices of the projected columns at the specified positions.

This function must be used if projection pushdown is enabled to figure out which columns to emit.

returns: The column indices at which to get the projected column index

pub fn get_extra_info<T>(&self) -> *const T

Retrieves the extra info of the function as set in TableFunction::set_extra_info

Arguments

• returns: The extra info

pub fn get_bind_data<T>(&self) -> *const T

Gets the bind data set by BindInfo::set_bind_data during the bind.

Note that the bind data should be considered as read-only. For tracking state, use the init data instead.

Arguments

• returns: The bind data object

pub fn set_max_threads(&self, max_threads: idx_t)

Sets how many threads can process this table function in parallel (default: 1)

Arguments

• max_threads: The maximum amount of threads that can process this table function

pub fn set_error(&self, error: CString)

Report that an error has occurred while calling init.

Arguments

• error: The error message

Trait Implementations

impl Debug for InitInfo

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

Formats the value using the given formatter.

impl From<*mut c_void> for InitInfo

fn from(ptr: duckdb_init_info) -> Self

Converts to this type from the input type.