Skip to main content

InitInfo

Struct InitInfo 

Source
pub struct InitInfo { /* private fields */ }
Expand description

Helper wrapper around duckdb_init_info for use inside init callbacks.

Provides ergonomic methods for the most common init operations.

Implementations§

Source§

impl InitInfo

Source

pub const unsafe fn new(info: duckdb_init_info) -> Self

Wraps a raw duckdb_init_info.

§Safety

info must be a valid duckdb_init_info provided by DuckDB.

Source

pub fn projected_column_count(&self) -> usize

Returns the number of projected (requested) columns.

Only valid when projection pushdown is enabled for the table function.

Source

pub fn projected_column_index(&self, projection_idx: usize) -> Option<usize>

Returns the declared column index at the given projection position, or None when projection_idx is not less than projected_column_count.

Only meaningful when projection pushdown is enabled.

duckdb_init_get_column_index answers an out-of-range position with 0 — indistinguishable from “the first declared column” — so the range check happens here.

Source

pub fn set_max_threads(&self, n: u64)

Sets the maximum number of threads for parallel scanning.

The default is 1. Above 1, DuckDB may call the scan callback from up to n threads at the same time, whether or not local_init is set (local_init only gives each thread its own state; it is not what enables parallelism). All of those calls share the one global init data and the one bind data, so after raising this, the scan must not use FfiInitData::get_mut; keep shared mutable state behind a Mutex or atomics instead.

Source

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

Reports an error from the init callback.

An interior null byte in message is replaced by ?. An empty message is replaced by EMPTY_ERROR_PLACEHOLDER.

Source

pub unsafe fn get_extra_info(&self) -> *mut c_void

Returns the extra info pointer set on the table function.

§Safety

The caller must ensure the returned pointer (if non-null) is used according to its original type.

Source

pub const fn as_raw(&self) -> duckdb_init_info

Returns the raw duckdb_init_info handle.

Trait Implementations§

Source§

impl Debug for InitInfo

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.