Skip to main content

IndexOverlay

Struct IndexOverlay 

Source
pub struct IndexOverlay(/* private fields */);
Expand description

Overlay for tracking uncommited transaction changes to indexes on a table.

1 Table has 1 IndexOverlay, which has n BTreeMaps for each index

Implementations§

Source§

impl IndexOverlay

Source

pub fn insert( &mut self, indexed_columns: &[&'static str], indexed_values: Vec<Value>, pk: Value, )

Inserts a record into the index overlay for the specified indexed columns, indexed values, and primary key.

The primary key is added to the set of primary keys associated with the indexed values in the added map. If the primary key was previously in the removed set for these values, it is removed from there.

Source

pub fn delete( &mut self, indexed_columns: &[&'static str], indexed_values: Vec<Value>, pk: Value, )

Removes a record from the index overlay for the specified indexed columns, indexed values, and primary key.

The primary key is added to the set of primary keys associated with the indexed values in the removed map. If the primary key was previously in the added set for these values, it is removed from there.

Source

pub fn added_pks( &self, indexed_columns: &[&'static str], indexed_values: &[Value], ) -> HashSet<Value>

Returns the set of primary keys added for the given index columns and indexed values.

Returns an empty set if no entries exist.

Source

pub fn removed_pks( &self, indexed_columns: &[&'static str], indexed_values: &[Value], ) -> HashSet<Value>

Returns the set of primary keys removed for the given index columns and indexed values.

Returns an empty set if no entries exist.

Source

pub fn added_pks_in_range( &self, indexed_columns: &[&'static str], start: Option<&[Value]>, end: Option<&[Value]>, ) -> HashSet<Value>

Returns the set of primary keys added within the given inclusive key range.

Source

pub fn removed_pks_in_range( &self, indexed_columns: &[&'static str], start: Option<&[Value]>, end: Option<&[Value]>, ) -> HashSet<Value>

Returns the set of primary keys removed within the given inclusive key range.

Source

pub fn update( &mut self, indexed_columns: &[&'static str], old_indexed_values: Vec<Value>, new_indexed_values: Vec<Value>, pk: Value, )

Updates a record in the index overlay by removing the old indexed values and inserting the new ones.

This is equivalent to calling delete with the old values followed by insert with the new values.

Trait Implementations§

Source§

impl Clone for IndexOverlay

Source§

fn clone(&self) -> IndexOverlay

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for IndexOverlay

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for IndexOverlay

Source§

fn default() -> IndexOverlay

Returns the “default value” for a type. 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.