Struct MultiIndex

pub struct MultiIndex<T>
where
    T: PrimaryValueInterface + SecondaryValueInterface + Packer + Default,
{
    pub code: Name,
    pub scope: Name,
    pub table: Name,
    pub db: TableI64<T>,
    pub idxdbs: Vec<Box<dyn IdxTable>>,
    /* private fields */
}

Fields

code: Name

scope: Name

table: Name

db: TableI64<T>

idxdbs: Vec<Box<dyn IdxTable>>

Implementations

impl<T> MultiIndex<T>

where T: PrimaryValueInterface + SecondaryValueInterface + Packer + Default,

pub fn new( code: Name, scope: Name, table: Name, indices: &[SecondaryType], ) -> Self

Creates a new instance of the MultiIndex struct.

pub fn store(&self, value: &T, payer: Name) -> Iterator<'_, T>

Stores a given value into the table with a specified payer.

pub fn find(&self, id: u64) -> Iterator<'_, T>

Searches for a record with a given primary key and returns an iterator.

pub fn update(&self, iterator: &Iterator<'_, T>, value: &T, payer: Name)

Updates the record pointed by the given iterator with a new value and payer.

pub fn remove(&self, iterator: &Iterator<'_, T>)

Removes the record pointed by the given iterator.

pub fn get(&self, iterator: &Iterator<'_, T>) -> Option<T>

Retrieves the value pointed by the given iterator.

pub fn get_by_primary(&self, primary: u64) -> Option<T>

Retrieves the value by its primary key.

pub fn next(&self, iterator: &Iterator<'_, T>) -> Iterator<'_, T>

Returns an iterator pointing to the next record.

pub fn previous(&self, iterator: &Iterator<'_, T>) -> Iterator<'_, T>

Returns an iterator pointing to the previous record.

pub fn lower_bound(&self, id: u64) -> Iterator<'_, T>

Returns an iterator pointing to the first record that is not less than the given primary key.

pub fn upper_bound(&self, id: u64) -> Iterator<'_, T>

Returns an iterator pointing to the first record that is greater than the given primary key.

pub fn end(&self) -> Iterator<'_, T>

Returns an iterator pointing to the end of the table.

pub fn get_idx_db(&self, i: usize) -> &dyn IdxTable

Retrieves a reference to the secondary index database at the given index.

pub fn idx_update( &self, it: &SecondaryIterator, value: SecondaryValue, payer: Name, )

Updates the secondary index with a given iterator, value, and payer.