Struct rusqlite::vtab::IndexInfo

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

Available on crate feature vtab only.

Pass information into and receive the reply from the VTab::best_index method.

(See SQLite doc)

Implementations

impl IndexInfo

pub fn constraints_and_usages(&mut self) -> IndexConstraintAndUsageIter<'_>

Iterate on index constraint and its associated usage.

pub fn constraints(&self) -> IndexConstraintIter<'_>

Record WHERE clause constraints.

pub fn order_bys(&self) -> OrderByIter<'_>

Information about the ORDER BY clause.

pub fn num_of_order_by(&self) -> usize

Number of terms in the ORDER BY clause

pub fn constraint_usage( &mut self, constraint_idx: usize ) -> IndexConstraintUsage<'_>

Information about what parameters to pass to VTabCursor::filter.

pub fn set_idx_num(&mut self, idx_num: c_int)

Number used to identify the index

pub fn set_idx_str(&mut self, idx_str: &str)

String used to identify the index

pub fn set_order_by_consumed(&mut self, order_by_consumed: bool)

True if output is already ordered

pub fn set_estimated_cost(&mut self, estimated_ost: f64)

Estimated cost of using this index

pub fn set_estimated_rows(&mut self, estimated_rows: i64)

Estimated number of rows returned.

pub fn set_idx_flags(&mut self, flags: IndexFlags)

Mask of SQLITE_INDEX_SCAN_* flags.

pub fn col_used(&self) -> u64

Mask of columns used by statement

pub fn collation(&self, constraint_idx: usize) -> Result<&str>

Available on crate feature modern_sqlite only.

Determine the collation for a virtual table constraint

Trait Implementations

impl Debug for IndexInfo

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

Formats the value using the given formatter.