pub struct IndexInfo(_);
This is supported on crate feature
vtab
only.Expand description
Pass information into and receive the reply from the
VTab::best_index
method.
(See SQLite doc)
Implementations
sourceimpl IndexInfo
impl IndexInfo
sourcepub fn constraints_and_usages(&mut self) -> IndexConstraintAndUsageIter<'_>ⓘNotable traits for IndexConstraintAndUsageIter<'a>impl<'a> Iterator for IndexConstraintAndUsageIter<'a> type Item = (IndexConstraint<'a>, IndexConstraintUsage<'a>);
pub fn constraints_and_usages(&mut self) -> IndexConstraintAndUsageIter<'_>ⓘNotable traits for IndexConstraintAndUsageIter<'a>impl<'a> Iterator for IndexConstraintAndUsageIter<'a> type Item = (IndexConstraint<'a>, IndexConstraintUsage<'a>);
Iterate on index constraint and its associated usage.
sourcepub fn constraints(&self) -> IndexConstraintIter<'_>ⓘNotable traits for IndexConstraintIter<'a>impl<'a> Iterator for IndexConstraintIter<'a> type Item = IndexConstraint<'a>;
pub fn constraints(&self) -> IndexConstraintIter<'_>ⓘNotable traits for IndexConstraintIter<'a>impl<'a> Iterator for IndexConstraintIter<'a> type Item = IndexConstraint<'a>;
Record WHERE clause constraints.
sourcepub fn order_bys(&self) -> OrderByIter<'_>ⓘNotable traits for OrderByIter<'a>impl<'a> Iterator for OrderByIter<'a> type Item = OrderBy<'a>;
pub fn order_bys(&self) -> OrderByIter<'_>ⓘNotable traits for OrderByIter<'a>impl<'a> Iterator for OrderByIter<'a> type Item = OrderBy<'a>;
Information about the ORDER BY clause.
sourcepub fn num_of_order_by(&self) -> usize
pub fn num_of_order_by(&self) -> usize
Number of terms in the ORDER BY clause
sourcepub fn constraint_usage(
&mut self,
constraint_idx: usize
) -> IndexConstraintUsage<'_>
pub fn constraint_usage(
&mut self,
constraint_idx: usize
) -> IndexConstraintUsage<'_>
Information about what parameters to pass to VTabCursor::filter
.
sourcepub fn set_idx_num(&mut self, idx_num: c_int)
pub fn set_idx_num(&mut self, idx_num: c_int)
Number used to identify the index
sourcepub fn set_order_by_consumed(&mut self, order_by_consumed: bool)
pub fn set_order_by_consumed(&mut self, order_by_consumed: bool)
True if output is already ordered
sourcepub fn set_estimated_cost(&mut self, estimated_ost: f64)
pub fn set_estimated_cost(&mut self, estimated_ost: f64)
Estimated cost of using this index
sourcepub fn set_estimated_rows(&mut self, estimated_rows: i64)
This is supported on crate feature modern_sqlite
only.
pub fn set_estimated_rows(&mut self, estimated_rows: i64)
This is supported on crate feature
modern_sqlite
only.Estimated number of rows returned.
Auto Trait Implementations
impl RefUnwindSafe for IndexInfo
impl !Send for IndexInfo
impl !Sync for IndexInfo
impl Unpin for IndexInfo
impl UnwindSafe for IndexInfo
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more