Struct robt::db::Index

pub struct Index<K, V, D, B> { /* fields omitted */ }

Index type, immutable, durable, fully-packed and lockless reads.

Implementations

impl<K, V, D, B> Index<K, V, D, B>

pub fn open(dir: &OsStr, name: &str) -> Result<Index<K, V, D, B>> where
    K: FromCbor,
    V: FromCbor,
    D: FromCbor,
    B: Bloom, 

Open an existing index for read-only.

pub fn open_file(file: &OsStr) -> Result<Index<K, V, D, B>> where
    K: FromCbor,
    V: FromCbor,
    D: FromCbor,
    B: Bloom, 

Open an existing index for read-only, from index file. file must be supplied along with full-path.

pub fn set_bitmap(&mut self, bitmap: B)

Optionally set a different bitmap over this index. Know what you are doing before calling this API.

pub fn try_clone(&self) -> Result<Self> where
    K: FromCbor,
    V: FromCbor,
    D: FromCbor, 

Clone this index instance, with its underlying meta-data shared across index instances. Note that file-descriptors are not shared.

pub fn compact(self, config: Config, bitmap: B, cutoff: Cutoff) -> Result<Self> where
    K: Clone + Ord + Hash + FromCbor + IntoCbor,
    V: Clone + FromCbor + IntoCbor,
    D: Clone + FromCbor + IntoCbor,
    B: Bloom, 

Compact this index into a new index specified by Config. The bitmap argument carry same meaning as that of build_index method. Refer to package documentation to know more about Cutoff.

pub fn close(self) -> Result<()>

Close this index, releasing OS resources. To purge, call purge() method.

pub fn purge(self) -> Result<()>

Purge this index from disk.

impl<K, V, D, B> Index<K, V, D, B>

pub fn to_name(&self) -> String

pub fn to_app_metadata(&self) -> Vec<u8>

pub fn to_stats(&self) -> Stats

pub fn as_bitmap(&self) -> &B

pub fn to_bitmap(&self) -> B where
    B: Clone, 

pub fn to_root(&self) -> u64

pub fn to_seqno(&self) -> u64

pub fn is_compacted(&self) -> bool

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn to_index_file_location(&self) -> OsString

pub fn to_vlog_file_location(&self) -> Option<OsString>

pub fn get<Q>(&mut self, key: &Q) -> Result<Entry<K, V, D>> where
    K: Clone + Borrow<Q> + FromCbor,
    V: Clone + FromCbor,
    D: Clone + FromCbor,
    Q: Ord, 

pub fn get_versions<Q>(&mut self, key: &Q) -> Result<Entry<K, V, D>> where
    K: Clone + Borrow<Q> + FromCbor,
    V: Clone + FromCbor,
    D: Clone + FromCbor,
    Q: Ord, 

pub fn iter<Q, R>(&mut self, range: R) -> Result<Iter<'_, K, V, D>> where
    K: Clone + Ord + Borrow<Q> + FromCbor,
    V: Clone + FromCbor,
    D: Clone + FromCbor,
    Q: Ord + ToOwned<Owned = K>,
    R: RangeBounds<Q>, 

pub fn reverse<Q, R>(&mut self, range: R) -> Result<Iter<'_, K, V, D>> where
    K: Clone + Ord + Borrow<Q> + FromCbor,
    V: Clone + FromCbor,
    D: Clone + FromCbor,
    Q: Ord + ToOwned<Owned = K>,
    R: RangeBounds<Q>, 

pub fn iter_versions<Q, R>(&mut self, range: R) -> Result<Iter<'_, K, V, D>> where
    K: Clone + Ord + Borrow<Q> + FromCbor,
    V: Clone + FromCbor,
    D: Clone + FromCbor,
    Q: Ord + ToOwned<Owned = K>,
    R: RangeBounds<Q>, 

pub fn reverse_versions<Q, R>(&mut self, range: R) -> Result<Iter<'_, K, V, D>> where
    K: Clone + Ord + Borrow<Q> + FromCbor,
    V: Clone + FromCbor,
    D: Clone + FromCbor,
    Q: Ord + ToOwned<Owned = K>,
    R: RangeBounds<Q>, 

pub fn validate(&mut self) -> Result<Stats> where
    K: Clone + PartialOrd + Ord + Debug + FromCbor,
    V: Clone + FromCbor,
    D: Clone + FromCbor, 

pub fn print(&mut self) -> Result<()> where
    K: Clone + FromCbor + Debug,
    V: Clone + FromCbor + Debug,
    D: Clone + FromCbor + Debug,
    B: Bloom,