Struct nebari::Config

pub struct Config<M: FileManager = StdFileManager> { /* private fields */ }

A database configuration used to open a database.

Implementations

impl Config<StdFileManager>

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

Creates a new config to open a database located at path.

pub fn default_for<P: AsRef<Path>>(path: P) -> Self

Returns a default configuration to open a database located at path.

pub fn file_manager<M: FileManager>(self, file_manager: M) -> Config<M>

Sets the file manager.

Panics

Panics if called after a shared thread pool has been set.

impl<M: FileManager> Config<M>

pub fn vault<V: AnyVault>(self, vault: V) -> Self

Sets the vault to use for this database.

pub fn cache(self, cache: ChunkCache) -> Self

Sets the chunk cache to use for this database.

pub fn shared_thread_pool(self, thread_pool: &ThreadPool<M::File>) -> Self

Uses the thread_pool provided instead of creating its own. This will allow a single thread pool to manage multiple Roots instances’ transactions.

pub fn open(self) -> Result<Roots<M::File>, Error>

Opens the database, or creates one if the target path doesn’t exist.

Trait Implementations

impl<M: FileManager> Clone for Config<M>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<M: Debug + FileManager> Debug for Config<M> where
    M::File: Debug, 

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.