Struct TableFunctionInfo 

pub struct TableFunctionInfo<V: VTab> { /* private fields */ }

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

Implementations

impl<V: VTab> TableFunctionInfo<V>

pub fn set_error(&self, error: &str)

Report that an error has occurred while executing the function.

Arguments

• error: The error message

pub fn get_bind_data(&self) -> &V::BindData

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.

pub fn get_init_data(&self) -> &V::InitData

Get a reference to the init data set by InitInfo::set_init_data during the init.

This returns a shared reference because the init data is shared between multiple threads. It may internally be mutable.

Arguments

• returns: The init data object

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

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

pub fn get_local_init_data<T>(&self) -> *mut T

Gets the thread-local init data set by InitInfo::set_init_data during the local_init.

Arguments

• returns: The init data object

Trait Implementations

impl<V: Debug + VTab> Debug for TableFunctionInfo<V>

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

Formats the value using the given formatter.

impl<V: VTab> From<*mut _duckdb_function_info> for TableFunctionInfo<V>

fn from(ptr: duckdb_function_info) -> Self

Converts to this type from the input type.