Struct Database

Source

pub struct Database { /* private fields */ }

Expand description

GrebeDB database interface.

Implementations§

Source §

impl Database

Source

pub fn open( vfs: Box<dyn Vfs + Sync + Send>, options: Options, ) -> Result<Self, Error>

Open a database using the given virtual file system and options.

Source

pub fn open_memory(options: Options) -> Result<Self, Error>

Open a database in temporary memory.

Source

pub fn open_path(root_path: P, options: Options) -> Result<Self, Error>
where P: Into<PathBuf>,

Open a database to a path on the disk.

The path must be a directory.

Source

pub fn metadata(&self) -> Metadata<'_>

Return database metadata information.

Source

pub fn contains_key<K>(&mut self, key: K) -> Result<bool, Error>
where K: AsRef<[u8]>,

Return whether the key exists.

Source

pub fn get<K>(&mut self, key: K) -> Result<Option<Vec<u8>>, Error>
where K: AsRef<[u8]>,

Retrieve a stored value, by its key, as a vector.

Source

pub fn get_buf<K>( &mut self, key: K, value_destination: &mut Vec<u8>, ) -> Result<bool, Error>
where K: AsRef<[u8]>,

Retrieve a stored value, by its key, into the given buffer.

Returns true if the key-value pair was found. The vector will be cleared and resized.

Source

pub fn put<K, V>(&mut self, key: K, value: V) -> Result<(), Error>
where K: Into<Vec<u8>>, V: Into<Vec<u8>>,

Store a key-value pair.

Source

pub fn remove<K>(&mut self, key: K) -> Result<(), Error>
where K: AsRef<[u8]>,

Remove a key-value pair by its key.

No error occurs if the key does not exist.

Source

pub fn cursor(&mut self) -> Result<Cursor<'_>, Error>

Return a cursor for iterating all the key-value pairs.

Source

pub fn cursor_range<K, R>(&mut self, range: R) -> Result<Cursor<'_>, Error>
where K: AsRef<[u8]>, R: RangeBounds<K>,

Return a cursor for iterating all the key-value pairs within the given range.

This method is equivalent of obtaining a cursor and calling Cursor::seek() and Cursor::set_range()

Source

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

Persist all modifications to the file system.

Calling this function ensures that all changes pending, whether cached in memory or in files, are atomically saved on the file system before this function returns. If the database is not flushed when dropped or the program exits, changes since the last successful flush will be discarded. This function effectively emulates a transaction.

For details about automatic flushing, see Options.

Source