Trait Index 

pub trait Index: Send + Sync {
    // Required methods
    fn insert(&mut self, key: &[u8], value: u64) -> Result<()>;
    fn find(&self, key: &[u8]) -> Result<Vec<u64>>;
    fn remove(&mut self, key: &[u8]) -> Result<bool>;
    fn len(&self) -> usize;
    fn clear(&mut self);
    fn index_type(&self) -> IndexType;

    // Provided method
    fn is_empty(&self) -> bool { ... }
}

Index trait defining the common interface for all index types

Required Methods

fn insert(&mut self, key: &[u8], value: u64) -> Result<()>

Insert a key-value pair into the index. The value is typically a pointer/offset to the actual data.

fn find(&self, key: &[u8]) -> Result<Vec<u64>>

Find all values matching the exact key.

fn remove(&mut self, key: &[u8]) -> Result<bool>

Remove all entries for a key from the index. Returns true if any entries were removed.

fn len(&self) -> usize

Returns the number of entries in the index.

fn clear(&mut self)

Clear all entries from the index.

fn index_type(&self) -> IndexType

Returns the index type.

Provided Methods

fn is_empty(&self) -> bool

Returns true if the index is empty.

Implementors

impl Index for BTreeIndex

impl Index for HashIndex