Struct grin_store::lmdb::Store

pub struct Store { /* private fields */ }

LMDB-backed store facilitating data access and serialization. All writes are done through a Batch abstraction providing atomicity.

Implementations

impl Store

pub fn new( root_path: &str, env_name: Option<&str>, db_name: Option<&str>, max_readers: Option<u32> ) -> Result<Store, Error>

Create a new LMDB env under the provided directory. By default creates an environment named “lmdb”. Be aware of transactional semantics in lmdb (transactions are per environment, not per database).

pub fn with_version(&self, version: ProtocolVersion) -> Store

Construct a new store using a specific protocol version. Permits access to the db with legacy protocol versions for db migrations.

pub fn protocol_version(&self) -> ProtocolVersion

Protocol version for the store.

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

Opens the database environment

pub fn needs_resize(&self) -> Result<bool, Error>

Determines whether the environment needs a resize based on a simple percentage threshold

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

Increments the database size by as many ALLOC_CHUNK_SIZES to give a minimum threshold of free space

pub fn get_with<F, T>( &self, key: &[u8], access: &ConstAccessor<'_>, db: &Database<'_>, deserialize: F ) -> Result<Option<T>, Error>

where F: Fn(&[u8], &[u8]) -> Result<T, Error>,

Gets a value from the db, provided its key. Deserializes the retrieved data using the provided function.

pub fn get_ser<T: Readable>( &self, key: &[u8], deser_mode: Option<DeserializationMode> ) -> Result<Option<T>, Error>

Gets a Readable value from the db, provided its key. Note: Creates a new read transaction so will not see any uncommitted data.

pub fn exists(&self, key: &[u8]) -> Result<bool, Error>

Whether the provided key exists

pub fn iter<F, T>( &self, prefix: &[u8], deserialize: F ) -> Result<PrefixIterator<F, T>, Error>

where F: Fn(&[u8], &[u8]) -> Result<T, Error>,

Produces an iterator from the provided key prefix.

pub fn batch(&self) -> Result<Batch<'_>, Error>

Builds a new batch to be used with this store.