Struct Index

Source
pub struct Index<K, V> { /* private fields */ }
Expand description

On-disk index structure mapping keys to values

Implementations§

Source§

impl<K, V> Index<K, V>
where K: 'static + Hash + Copy + PartialEq, V: 'static + Hash + Copy,

Source

pub fn new<P: AsRef<Path>>(path: &P) -> Result<Self>

Create or load an index at path

Source

pub fn pages(&self) -> usize

Returns how many pages have been allocated so far

Source

pub fn insert(&self, key: K, val: V) -> Result<AlreadyThere>

Inserts a key-value pair into the index, if the key is already present, this is a no-op

Source

pub fn get(&self, key: &K) -> Result<Option<&V>>

Looks up a value with key in the index

Source

pub fn flush(&mut self) -> Result<()>

Syncronizes and flushes data to disk

Source

pub fn on_disk_size(&self) -> usize

Get the approximate size on disk for the index

Trait Implementations§

Source§

impl<K, V> Send for Index<K, V>
where K: Send, V: Send,

Source§

impl<K, V> Sync for Index<K, V>
where K: Sync, V: Sync,

Auto Trait Implementations§

§

impl<K, V> !Freeze for Index<K, V>

§

impl<K, V> !RefUnwindSafe for Index<K, V>

§

impl<K, V> Unpin for Index<K, V>
where K: Unpin, V: Unpin,

§

impl<K, V> UnwindSafe for Index<K, V>
where K: UnwindSafe, V: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> Erased for T