Struct indexkv::Store

pub struct Store<T: Serialize + DeserializeOwned> { /* fields omitted */ }

Implementations

impl<T: Serialize + DeserializeOwned + Debug> Store<T>

pub async fn new(path: impl AsRef<Path>) -> Result<Self, Error>

Allocates a new Store containing no values. Opens a file descriptor to path.

pub async fn stream_values(
    &self
) -> Result<impl Stream<Item = Result<T, Error>>, Error>

Provides a sequential stream of all values in the Store. In relational database parlance, this would be a tablescan.

pub async fn get(&mut self, key: u64) -> Result<T, Error>

Looks up a single value by key. Will attempt to cache data positions in the backing file to minimize disk seeking. Returns Error::NotFound when key does not exist in the Store.

pub async fn get_many(
    &mut self,
    keys_in: &[u64]
) -> Result<HashMap<u64, T>, Error>

Looks up multiple values by key. Will find (uncached) keys in sorted order to minimize disk seeking back and forth. Does not return an error when key does not exist; calling code should check for Some vs None in the resulting HashMap for fallibility.

pub async fn write(
    &mut self,
    pairs: impl Stream<Item = (u64, T)> + Unpin
) -> Result<(), Error>

Consumes a stream of (key, value) pairs. Sequentially writes all the values to disk, noting their positions, then goes back and sequentially writes down the sorted index.