Struct exonum_merkledb::IndexBuilder

pub struct IndexBuilder<T> { /* fields omitted */ }

Struct responsible for creating view and state for index with specified address. View contains changes, state contains metadata.

Example

use exonum_merkledb::{Database, TemporaryDB, IndexBuilder, ListIndex};

let db: Box<Database> = Box::new(TemporaryDB::new());
let fork = db.fork();
{
    let (view, _state) = IndexBuilder::new(&fork)
        .index_name("index")
        .build::<()>();
}

Methods

impl<T> IndexBuilder<T> where
    T: IndexAccess, 

pub fn new(index_access: T) -> Self

Creates a new index based on provided `index_access'.

pub fn from_address<I: Into<IndexAddress>>(address: I, index_access: T) -> Self

Creates a new index from provided address.

pub fn index_name<S: Into<String>>(self, index_name: S) -> Self

Provides first part of the index address.

pub fn family_id<I: ?Sized>(self, family_id: &I) -> Self where
    I: BinaryKey, 

Provides family_id for the index address.

pub fn index_type(self, index_type: IndexType) -> Self

Sets the type of the given index.

pub fn build<V>(self) -> (View<T>, IndexState<T, V>) where
    V: BinaryAttribute + Default + Copy, 

Returns index based on specified view and address. Allowable characters in index name: ASCII characters, digits, underscores and dashes.

Panics

• If index name is empty or invalid.
• If index metadata doesn't match expected.

pub fn build_existed<V>(self) -> Option<(View<T>, IndexState<T, V>)> where
    V: BinaryAttribute + Default + Copy, 

Similar to build, but returns None if index has not been created yet.

Trait Implementations

impl<T: Debug> Debug for IndexBuilder<T>

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

Formats the value using the given formatter.