Struct rkv::Manager

pub struct Manager<E> { /* fields omitted */ }

A process is only permitted to have one open handle to each Rkv environment. This manager exists to enforce that constraint: don't open environments directly.

Implementations

impl<'e, E> Manager<E> where
    E: BackendEnvironment<'e>, 

pub fn get<'p, P>(
    &self,
    path: P
) -> Result<Option<Arc<RwLock<Rkv<E>>>>, StoreError> where
    P: Into<&'p Path>, 

Return the open env at path, returning None if it has not already been opened.

pub fn get_or_create<'p, F, P>(
    &mut self,
    path: P,
    f: F
) -> Result<Arc<RwLock<Rkv<E>>>, StoreError> where
    F: FnOnce(&Path) -> Result<Rkv<E>, StoreError>,
    P: Into<&'p Path>, 

Return the open env at path, or create it by calling f.

pub fn get_or_create_with_capacity<'p, F, P>(
    &mut self,
    path: P,
    capacity: c_uint,
    f: F
) -> Result<Arc<RwLock<Rkv<E>>>, StoreError> where
    F: FnOnce(&Path, c_uint) -> Result<Rkv<E>, StoreError>,
    P: Into<&'p Path>, 

Return the open env at path with capacity, or create it by calling f.

pub fn get_or_create_from_builder<'p, F, P, B>(
    &mut self,
    path: P,
    builder: B,
    f: F
) -> Result<Arc<RwLock<Rkv<E>>>, StoreError> where
    F: FnOnce(&Path, B) -> Result<Rkv<E>, StoreError>,
    P: Into<&'p Path>,
    B: BackendEnvironmentBuilder<'e, Environment = E>, 

Return a new Rkv environment from the builder, or create it by calling f.

pub fn try_close_and_delete<'p, P>(&mut self, path: P) -> Result<(), StoreError> where
    P: Into<&'p Path>, 

Tries to close the specified environment and delete all its files from disk. Doesn't delete the folder used when opening the environment. This will only work if there's no other users of this environment.

impl Manager<LmdbEnvironment>

pub fn singleton() -> &'static RwLock<Manager<LmdbEnvironment>>

impl Manager<SafeModeEnvironment>

pub fn singleton() -> &'static RwLock<Manager<SafeModeEnvironment>>